verilator/docs
Wilson Snyder 1f0357ba93 Add NOEFFECT warning, replacing previous `foreach` error. 2025-07-16 08:18:57 -04:00
..
_static Fix Codacy warnings. No functional change. 2021-07-07 19:42:49 -04:00
bin Copyright year update. 2025-01-01 08:30:25 -05:00
gen Disable symbol from parser: Support redeclaring type as non-type; major parsing change (#2412). 2025-05-18 07:13:37 -04:00
guide Add NOEFFECT warning, replacing previous `foreach` error. 2025-07-16 08:18:57 -04:00
.gitignore Spelling fixes. 2022-05-14 16:12:57 -04:00
CONTRIBUTING.rst Commentary 2025-02-15 00:58:14 -05:00
CONTRIBUTORS Fix omitting error when assigning to an input (#6169) 2025-07-10 20:37:55 -04:00
Makefile Internals: Add format-make rule and standardize Makefile indents. No functional change intended. 2025-06-24 17:58:55 -04:00
README.rst Commentary: add docs/README.rst 2023-11-11 17:19:27 -05:00
internals.rst Add RTLMeter badge and note in internals docs (#6095) 2025-06-16 16:35:31 +01:00
security.rst Add security policy 2025-05-16 22:08:12 -04:00
spelling.txt Commentary: Changes update 2025-07-11 21:53:29 -04:00
verilated.dox Cleanup missing copyrights and those on simply copied files. No functional change. 2023-01-20 20:42:30 -05:00
xml.rst Copyright year update. 2025-01-01 08:30:25 -05:00

README.rst

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>`_