| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 1 | # OpenTitan |
| 2 | |
| 3 | This repository contains hardware, software and utilities written as part of the |
| 4 | OpenTitan project. It is structured as monolithic repository, or "monorepo", |
| 5 | where all components live in one repository. |
| 6 | |
| 7 | ## Documentation |
| 8 | |
| 9 | The project contains comprehensive documentation of all IPs and tools. You can |
| 10 | either access it [online](https://bubble.servers.lowrisc.org/) or build it |
| 11 | locally by following the steps below. |
| 12 | |
| 13 | 1. Ensure that you have the required Python modules installed (to be executed |
| 14 | in the repository root): |
| 15 | |
| 16 | ```command |
| 17 | $ sudo apt install python3 python3-pip |
| 18 | $ pip3 install --user -r python-requirements.txt |
| 19 | ``` |
| 20 | |
| 21 | 2. Execute the build script: |
| 22 | |
| 23 | ```command |
| 24 | $ ./util/build_docs.py --preview |
| 25 | ``` |
| 26 | |
| 27 | This compiles the documentation into `./opentitan-docs` and starts a local |
| 28 | server, which allows you to access the documentation at |
| 29 | [http://127.0.0.1:5500](http://127.0.0.1:5500). |
| 30 | |
| 31 | ## How to contribute |
| 32 | |
| 33 | Have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines how to |
| 34 | contribute code to this repository. |
| 35 | |
| 36 | ## Licensing |
| 37 | |
| 38 | Unless otherwise noted, everything in this repository is covered by the Apache |
| 39 | License, Version 2.0 (see [LICENSE](LICENSE) for full text). |
