| commit | dae614b8958c15e0ad794611e3fc9a591eb8cb60 | [log] [tgz] |
|---|---|---|
| author | Eunchan Kim <eunchan@google.com> | Wed Oct 09 10:36:40 2019 -0700 |
| committer | Eunchan Kim <eunchan@google.com> | Tue Oct 22 11:20:14 2019 -0700 |
| tree | 5b0ecf569f323cc105c00236316a2cd55e908d6e | |
| parent | d11f4b9172b919e5eb6ae2a287db4cc5a31f7afd [diff] |
[doc/ug] Github commit & merge guide Now the repo only supports `Rebase and Merge` option, the doc is revised to explain how to pack commits into a commit. Also, added guideline of commit message while squashing.
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.
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.
$ sudo apt install python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./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.
Have a look at CONTRIBUTING.md for guidelines how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).