search

efabless / caravel_user_project

https://caravel-user-project.readthedocs.io
Apache License 2.0
174 stars 326 forks source link

document the filesystem layout requirement for tapeout #230

Open proppy opened 1 year ago

proppy commented 1 year ago

It would be to explicitly document the directories and files layout requirements for satisfying a tapeout project submission on efabless.com.

Even if the current directory structure in caravel_user_project somehow document them implicitly, as commented in #131 it is not clear which files belong to the repo sources and which one are generated by the flow without digging in the non-trivial the Makefile hierarchy that span across multiple repositories.

And the current situation could lead erroneous project submission and confusion as to which file is actually used for tapeout, as shown in https://github.com/efabless/caravel-gf180mcu/issues/169.

proppy commented 1 year ago

@xobs pointed out some documentation is already available (albeit outdated) here: https://github.com/efabless/caravel/tree/main#required-directory-structure