Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
mithro opened this issue Jul 23, 2021 · 2 comments
Assignees

Comments

@mithro
Copy link
Contributor

mithro commented Jul 23, 2021

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.

@mithro
Copy link
Contributor Author

mithro commented Jul 23, 2021

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

@mithro mithro changed the title Rename "Getting Started" section to "Getting started with Developing the SymbiFlow Toolchain" Rename "Getting Started" section to "Getting started with developing the SymbiFlow Toolchain" Jul 23, 2021
@kgugala kgugala assigned kgugala and unassigned mgielda Jul 26, 2021
@tmichalak
Copy link
Contributor

Fixed with PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants