verilator/docs
Wilson Snyder 4080284e53
Fix warning lint directive ordering and consistency (#4185) (#5368) (#5610) (#6876).
2025-12-30 20:31:34 -05:00
..
_static Fix Codacy warnings. No functional change. 2021-07-07 19:42:49 -04:00
bin Internals: Add more python strict typing. No functional change intended 2025-11-01 14:14:56 -04:00
gen Tests: Reformat some recent tests to mostly verilog-format standard. No test functional change. 2025-12-20 21:46:43 -05:00
guide Fix warning lint directive ordering and consistency (#4185) (#5368) (#5610) (#6876). 2025-12-30 20:31:34 -05:00
.gitignore Spelling fixes. 2022-05-14 16:12:57 -04:00
CONTRIBUTING.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
CONTRIBUTORS Fix missing include on FreeBSD (#6864) 2025-12-27 10:17:03 -05:00
Makefile Commentary: Changes update 2025-07-16 17:26:01 -04:00
README.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
internals.rst Internals: Cleanup some docstrfmt issues. 2025-12-20 22:41:26 -05:00
security.rst Add security policy 2025-05-16 22:08:12 -04:00
spelling.txt Commentary: Changes update 2025-12-30 07:34:09 -05: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 Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -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>`_