Google Git
Sign in
opensecura / 3p / lowrisc / opentitan / 1a95dd9055bd894fb94682125f6e38356f996b33
commit1a95dd9055bd894fb94682125f6e38356f996b33[log] [tgz]
authorEunchan Kim <eunchan@google.com>Fri Oct 11 11:18:13 2019 -0700
committerEunchan Kim <eunchan@google.com>Thu Oct 17 15:01:26 2019 -0700
tree42c5f8a6049d15801a5d96750530d2ac29a031c4
parentd61724d47ee077cef3d60586880d69d36e7a689a [diff]
[top_earlgrey] Restructure top files

ip files are moved to under `hw/top_earlgrey/ip/{ip}/(rtl|doc|etc)/autogen`
top generated files are also moved to follow the convention.
5 files changed
tree: 42c5f8a6049d15801a5d96750530d2ac29a031c4
  1. .github/
  2. ci/
  3. doc/
  4. hw/
  5. sw/
  6. test/
  7. util/
  8. .clang-format
  9. .gitignore
  10. .style.yapf
  11. azure-pipelines.yml
  12. CONTRIBUTING.md
  13. index.md
  14. LICENSE
  15. meson.build
  16. meson_init.sh
  17. meson_options.txt
  18. python-requirements.txt
  19. README.md
  20. sitemap.md
  21. toolchain.txt
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).