Improving the README.md: Providing More Detailed Step-by-Step Command Instructions

[LJY2000-max]

Your README.md file is terribly written. I followed the process you provided to install RISCOF, and under RISCOF, there are two components: riscv-ctg and riscv-isac. Why didn’t you include a step to first git clone this project and then use the command cd riscv-ctg inside the project’s folder?

Next, for the installation of Spike and SAIL, you similarly failed to specify which directory to perform the git clone in. How is anyone supposed to know where these cloned files should be placed?

Additionally, regarding the required environment files, there’s no explanation of how to write the config.ini file or where it should be located. For the riscv-test-suite and riscv-config, which are already present in this project’s directories, why are they even mentioned as needing to be cloned? Even if cloning is necessary, there’s no clarification on which directory to clone them into.

Lastly, when running tests, why didn’t you specify which directory the tests should be executed in?

In conclusion: This is an absolutely awful README.md file,I spent so many days to creating environment, but never succeeded.

[allenjbaum]

I think we will have to plead guilty on all counts. But, of course, resources: The original authors are gone, and maintenance has been focused on just about everything else (primarily the tests themselves, etc). if you would update the docs with clarifications that you think are needed, file a PR and we will get them into the docs.

…

On Mon, Jan 20, 2025 at 5:06 AM LJY2000-max ***@***.***> wrote: Your README.md file is terribly written. I followed the process you provided to install RISCOF, and under RISCOF, there are two components: riscv-ctg and riscv-isac. Why didn’t you include a step to first git clone this project and then use the command cd riscv-ctg inside the project’s folder? Next, for the installation of Spike and SAIL, you similarly failed to specify which directory to perform the git clone in. How is anyone supposed to know where these cloned files should be placed? Additionally, regarding the required environment files, there’s no explanation of how to write the config.ini file or where it should be located. For the riscv-test-suite and riscv-config, which are already present in this project’s directories, why are they even mentioned as needing to be cloned? Even if cloning is necessary, there’s no clarification on which directory to clone them into. Lastly, when running tests, why didn’t you specify which directory the tests should be executed in? In conclusion: This is an absolutely awful README.md file,I spent so many days to creating environment, but never succeeded. — Reply to this email directly, view it on GitHub <#602>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHPXVJQLJTHZJRNREE2PR4D2LTYFPAVCNFSM6AAAAABVQKVEO2VHI2DSMVQWIX3LMV43ASLTON2WKOZSG44TSMRSGQ3TAOI> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>