aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKrystalDelusion <93062060+KrystalDelusion@users.noreply.github.com>2022-11-16 00:55:22 +1300
committerGitHub <noreply@github.com>2022-11-15 12:55:22 +0100
commita14dec79ebc85fae807684fa027d8098a16a4d34 (patch)
treef05562ce671f452f6d29a90219cced0b37c1aae4 /README.md
parent853f4bb3c695d9f5183ef5064ec4cf9cdd8b5300 (diff)
downloadyosys-a14dec79ebc85fae807684fa027d8098a16a4d34.tar.gz
yosys-a14dec79ebc85fae807684fa027d8098a16a4d34.tar.bz2
yosys-a14dec79ebc85fae807684fa027d8098a16a4d34.zip
Rst docs conversion (#3496)
Rst docs conversion
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index f916b38ad..d0f46f244 100644
--- a/README.md
+++ b/README.md
@@ -624,3 +624,27 @@ Notes:
- To run `make manual` you need to have installed Yosys with `make install`,
otherwise it will fail on finding `kernel/yosys.h` while building
`PRESENTATION_Prog`.
+
+Building the website
+====================
+
+If you're seeing this, it means you are on an as yet unmerged branch (I hope),
+and the website version of the documentation is not yet publicly available.
+
+In addition to those listed above for building Yosys from source, the following
+packages are used for building the website:
+
+ $ sudo apt-get install pdf2svg
+
+PDFLaTeX, included with most LaTeX distributions, is also needed during the
+build process for the website.
+
+The Python package, Sphinx, is needed along with those listed in
+`docs/source/requirements.txt`:
+
+ $ pip install -U sphinx -r docs/source/requirements.txt
+
+From the root of the repository, run `make docs`. This will build/rebuild yosys
+as necessary before generating the website documentation from the yosys help
+commands. To build for pdf instead of html, call
+`make docs DOC_TARGET=latexpdf`.