systemc.org

Website sources rendered using MkDocs

See the published website at https://systemc.org

Copyright © 2024 Accellera Systems Initiative

Contributing via pull requests

Please check the CONTRIBUTING guidelines how to contribute to https://systemc.org. It is recommended to install MkDocs to validate your contributions first.

pip install mkdocs

A detailed MkDocs installation procedure can be found here.

Before creating a pull request, it is recommended to preview your edits in a locally rendered website, by running the mkdocs serve command:

$ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes

Open up http://127.0.0.1:8000/ in your browser, and you'll see the website displayed. If your rendered content looks good, you can proceed with the submission of your pull request.