chipsalliance / f4pga

FOSS Flow For FPGA

Home Page:https://f4pga.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rename "Getting Started" section to "Getting started with developing the SymbiFlow Toolchain"

mithro opened this issue · comments

People seem to keep ending up at https://symbiflow.readthedocs.io/en/latest/symbiflow-arch-defs/docs/source/getting-started.html and think it is instructions for how to get started with SymbiFlow as a user.

They also ignore the note at the top which says "If you are looking for user documentation, please look at https://github.com/SymbiFlow/symbiflow-examples instead."

I think we need to clearly rename the section to something like "Getting started with development of the SymbiFlow Toolchain" or something.

We should also expand the sections under "Prepare Environment" and "Build example" to explain that you are building the development architecture files and this is expected to take a long time on a fast machine.

@mgielda - Can you assign someone to look at fixing this as soon as possible?

Fixed with PR