Improve documentation - Githubissues

YosysHQ / apicula

Project Apicula 🐝: bitstream documentation for Gowin FPGAs

MIT License

496 stars 67 forks source link

Improve documentation #289

Open pepijndevos opened 1 week ago

pepijndevos commented 1 week ago

We should make it as easy as possible to get started with Apicula. Part of that is writing documentation, part of that is working with toolchain distributions to package Apicula

User:

Review and update oss-cad-suite distribution
Write documentation about all command line options
Write documentation about all supported primitives
Streamline the readme for getting started

Developer:

https://github.com/YosysHQ/apicula/issues/282#issuecomment-2424656059
someone asked me about explaining the architecture of how the chipdb is built and flows between apicula and nextpnr but I forgot where

pepijndevos commented 1 week ago

it seems like oss-cad-suite ships with nextpnr-himbaechel and apicula so it looks like there isn't anything to be done there

https://github.com/YosysHQ/oss-cad-suite-build/blob/main/default/scripts/apicula.sh https://github.com/YosysHQ/oss-cad-suite-build/blob/main/default/scripts/nextpnr-himbaechel-gowin.sh

pepijndevos commented 1 week ago

The readme seems fine honestly, I've removed some outdated parts in adab34b53bf357afc1532d1561348c2c6ccf9f54 and I guess I'll add a link later to the wiki where I plan to host most of this.

Or idk, I'm open to opinions. We have a docs folder, which is all developer documentation. So maybe I'll keep adding developer stuff there but put user documentation in the wiki so it's easy to browse?

pepijndevos commented 1 week ago

Alright I've added documentation for all the command line options https://github.com/YosysHQ/apicula/wiki