3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-04 02:10:24 +00:00

Merge pull request #5262 from mattyoung101/update-readme

docs: mention Yosys Discourse group and blog
This commit is contained in:
KrystalDelusion 2025-08-02 14:03:17 +12:00 committed by GitHub
commit 366cb5e6dd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 10 deletions

View file

@ -1,11 +1,8 @@
contact_links:
- name: Discussions
url: https://github.com/YosysHQ/yosys/discussions
about: "Have a question? Ask it on our discussions page!"
- name: Community Slack
url: https://join.slack.com/t/yosyshq/shared_invite/zt-1aopkns2q-EiQ97BeQDt_pwvE41sGSuA
about: "Yosys Community Slack"
- name: Discourse
url: https://yosyshq.discourse.group
about: "Have a question? Ask it on our Discourse group!"
- name: IRC Channel
url: https://web.libera.chat/#yosys
about: "#yosys on irc.libera.chat"

View file

@ -25,6 +25,9 @@ Web Site and Other Resources
More information and documentation can be found on the Yosys web site:
- https://yosyshq.net/yosys/
If you have any Yosys-related questions, please post them on the Discourse group:
- https://yosyshq.discourse.group
Documentation from this repository is automatically built and available on Read
the Docs:
- https://yosyshq.readthedocs.io/projects/yosys
@ -34,6 +37,9 @@ verification front-end for Yosys, SBY:
- https://yosyshq.readthedocs.io/projects/sby/
- https://github.com/YosysHQ/sby
The Yosys blog has news and articles from users:
- https://blog.yosyshq.com
Installation
============
@ -242,7 +248,7 @@ Note that there is no need to build the manual if you just want to read it.
Simply visit https://yosys.readthedocs.io/en/latest/ instead.
In addition to those packages listed above for building Yosys from source, the
following are used for building the website:
following are used for building the website:
$ sudo apt install pdf2svg faketime
@ -258,7 +264,7 @@ build process for the website. Or, run the following:
Or for MacOS, using homebrew:
$ brew install basictex
$ sudo tlmgr update --self
$ sudo tlmgr update --self
$ sudo tlmgr install collection-latexextra latexmk tex-gyre
The Python package, Sphinx, is needed along with those listed in
@ -268,5 +274,5 @@ The Python package, Sphinx, is needed along with those listed in
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
commands. To build for pdf instead of html, call
`make docs DOC_TARGET=latexpdf`.