aboutsummaryrefslogtreecommitdiffstats
path: root/guidelines
diff options
context:
space:
mode:
authorClaire Xenia Wolf <claire@clairexen.net>2023-01-11 04:10:12 +0100
committerClaire Xenia Wolf <claire@clairexen.net>2023-01-11 04:10:12 +0100
commit6d56d4ecfc2c9afda3fd58f945a5f10daf87a999 (patch)
tree8b2e2cd5018674f287ae8b2c20877615fec8b555 /guidelines
parent029b0aac7f10ff5e1d927fb6ec1d9571a5350176 (diff)
parent7b476996df962b63656152f643ff2181143f516e (diff)
downloadyosys-6d56d4ecfc2c9afda3fd58f945a5f10daf87a999.tar.gz
yosys-6d56d4ecfc2c9afda3fd58f945a5f10daf87a999.tar.bz2
yosys-6d56d4ecfc2c9afda3fd58f945a5f10daf87a999.zip
Merge branch 'master' of github.com:YosysHQ/yosys into claire/eqystuff
Diffstat (limited to 'guidelines')
-rw-r--r--guidelines/Checklists14
-rw-r--r--guidelines/GettingStarted2
2 files changed, 6 insertions, 10 deletions
diff --git a/guidelines/Checklists b/guidelines/Checklists
index cc61c7876..51756cfd7 100644
--- a/guidelines/Checklists
+++ b/guidelines/Checklists
@@ -11,7 +11,7 @@ Things to do right away:
Things to do after finalizing the cell interface:
- Add support to kernel/satgen.h for the new cell type
- - Add to manual/CHAPTER_CellLib.tex (or just add a fixme to the bottom)
+ - Add to docs/source/CHAPTER_CellLib.rst (or just add a fixme to the bottom)
- Maybe add support to the Verilog backend for dumping such cells as expression
@@ -29,11 +29,9 @@ Update the CHANGELOG file:
Update and check documentation:
cd ~yosys
- make update-manual
- make manual
- - sanity check the figures in the appnotes and presentation
+ make docs
+ - sanity check the figures in docs/images
- if there are any odd things -> investigate
- - make cosmetic changes to the .tex files if necessary
cd ~yosys
vi README guidelines/*
@@ -108,13 +106,11 @@ Release:
Updating the website:
cd ~yosys
- make manual
make install
- - update pdf files on the website
-
cd ~yosys-web
- make update_cmd
make update_show
git commit -am update
make push
+
+ - Read the Docs updates handled by Jenkins on source change
diff --git a/guidelines/GettingStarted b/guidelines/GettingStarted
index fcc84c153..d27b285fc 100644
--- a/guidelines/GettingStarted
+++ b/guidelines/GettingStarted
@@ -191,7 +191,7 @@ Example Code
The following yosys commands are a good starting point if you are looking for examples
of how to use the Yosys API:
- manual/CHAPTER_Prog/stubnets.cc
+ docs/source/CHAPTER_Prog/stubnets.cc
manual/PRESENTATION_Prog/my_cmd.cc