Google Git
Sign in
opensecura / 3p / lowrisc / opentitan / c705000ca188c4456f31981b152a581f1ec7d68e
commitc705000ca188c4456f31981b152a581f1ec7d68e[log] [tgz]
authorMiguel Osorio <miguelosorio@google.com>Fri Sep 20 00:16:04 2019 -0700
committerMiguel Osorio <miguelaosoriol@gmail.com>Fri Sep 20 02:20:04 2019 -0700
treeffcbd24e65c292a8a153ea9fd486137f57447bd5
parent4735f89462c1a69d4f8233f198f914e506ac264f [diff]
[util] Make sure get-toolchain downloads tar file

Sometimes the release API returns files out of order, listing the log
file before the tar archive. This commit adds an additional suffix check
to make sure we download the tar file.
1 file changed
tree: ffcbd24e65c292a8a153ea9fd486137f57447bd5
  1. doc/
  2. hw/
  3. sw/
  4. util/
  5. .clang-format
  6. .gitignore
  7. .style.yapf
  8. azure-pipelines.yml
  9. CONTRIBUTING.md
  10. index.md
  11. LICENSE
  12. python-requirements.txt
  13. README.md
  14. sitemap.md
README.md

OpenTitan

This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository.

Documentation

The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.

  1. Ensure that you have the required Python modules installed (to be executed in the repository root):
$ sudo apt install python3 python3-pip
$ pip3 install --user -r python-requirements.txt
  1. Execute the build script:
$ ./util/build_docs.py --preview

This compiles the documentation into ./opentitan-docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:5500.

How to contribute

Have a look at CONTRIBUTING.md for guidelines how to contribute code to this repository.

Licensing

Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).