Commentary: add docs/README.rst

This commit is contained in:
Wilson Snyder 2023-11-11 17:19:27 -05:00
parent cad2780219
commit 4103925835
2 changed files with 22 additions and 0 deletions

21
docs/README.rst Normal file
View File

@ -0,0 +1,21 @@
Verilator Documentation
=======================
This folder contains sources for Verilator documentation.
For formatted documentation see:
- `Verilator README <https://github.com/verilator/verilator>`_
- `Verilator installation and package directory structure
<https://verilator.org/install>`_
- `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_,
or `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_
- `Subscribe to Verilator announcements
<https://github.com/verilator/verilator-announce>`_
- `Verilator forum <https://verilator.org/forum>`_
- `Verilator issues <https://verilator.org/issues>`_

View File

@ -28,6 +28,7 @@ our @Exempt_Files_List = qw(
ci/coverage-upload.sh
docs/CONTRIBUTING.rst
docs/CONTRIBUTORS
docs/README.rst
docs/_static
docs/gen
docs/spelling.txt