Google Git
Sign in
opensecura / 3p / lowrisc / opentitan / 1351b98ce4ccc4016846c785122a049c42ca824b
commit1351b98ce4ccc4016846c785122a049c42ca824b[log] [tgz]
authorMiguel Osorio <miguelosorio@google.com>Tue Sep 24 18:05:37 2019 -0700
committerMiguel Osorio <miguelaosoriol@gmail.com>Wed Sep 25 08:26:52 2019 -0700
tree5e9e1c56489ae0a6a0883bd6158a6fbb44767ecc
parent88179fc760529329c01916b3504d15af36fed5fd [diff]
[util] Update get-toolchain.py to work with Py3.5

pathlin.Path does not work well with shutil and os.path functions in
Python 3.5. Convert PosixPath to string before calling these functions.
1 file changed
tree: 5e9e1c56489ae0a6a0883bd6158a6fbb44767ecc
  1. ci/
  2. doc/
  3. hw/
  4. sw/
  5. util/
  6. .clang-format
  7. .gitignore
  8. .style.yapf
  9. azure-pipelines.yml
  10. CONTRIBUTING.md
  11. index.md
  12. LICENSE
  13. python-requirements.txt
  14. README.md
  15. 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).