RTimothyEdwards / qflow

Qflow full end-to-end digital synthesis flow for ASIC designs
183 stars 36 forks source link

Not obvious what each step does #39

Open hughperkins opened 2 years ago

hughperkins commented 2 years ago

I feel that whilst qflow is probably understandable by hardcore hackers, who already know what to do, the learning curve is quite steep, and could be flattened a little, by providing a little more explanation about what is going on at each step.

This could be as simple as adding more output to the qflow console when running each step.

"The layout step does [what layout step does]. The input file is [input file name path here]. The output file is [output filepath here]. The input file format represents [what the input file represents]. The output file format represents [what the output file represents here]. The commandline we are running is:

[commandline here]

The tool we are using to do this is called [name of tool] here. Some more information on this tool can be found at [url here]."

Thank you very much for creating qflow. It looks pretty cool :) I like the fact that you managed to tape-out your own custom ASIC processor using it, and it worked first time :) (I also like that it is targeting ASICs rather than FPGAs.)

(Edit: like, imagine that qflow is a computer game, that people are playing for fun. How can they play the game without having to read through too much information about each tool first? Like, you want to qflow to 'just work' for people I guess :) )