Installation and use instructions #3
Description
Is it possible to have more details added about the installation and use of the SRCompiler?
For example, the readme doesn't describe how to download SRCompiler or how to build it.
The readme mentions some pre-requisites, but doesn't provide links or instructions on where to find and/or download those "If you want to build the project, you will need a C++ compiler, Bison, Flex and Make installed." It would help the naive user by providing some more description of this process.
The readme also mentions that the user can build the project:
"Simply run:
$ build.sh"
but it isn't clear where one should run build.sh (console, bash, etc.) and what environment it should be in (e.g., working directory of downloaded SRCompiler).
I think more instructions on how to use this tool would make it more approachable for a broader userbase. The pdf https://www.biorxiv.org/content/10.1101/2024.01.08.574614v1.full.pdf is useful for understanding how SRCompiler was put together, but it is notably not a user manual.