Rewrite Readme by usage of an popular template and adding a Makefile ✍️

oschwengers / asap

A scalable bacterial genome assembly, annotation and analysis pipeline

https://doi.org/10.1371/journal.pcbi.1007134

GNU General Public License v3.0

66 stars 18 forks source link

Rewrite Readme by usage of an popular template and adding a Makefile ✍️ #13

Closed tgotwig closed 3 years ago

tgotwig commented 3 years ago

Hello there 🙋‍♂️

The readme doesn't explain very well how to setup for development, and it has some other issues, I think a rewrite along with this template would improve it a lot 👇 https://github.com/elsewhencode/project-guidelines/blob/master/README.sample.md

Also a Makefile would be nice to have an straight way to execute things (like script inside of package.json files) and reduce the size of the readme 🙂

oschwengers commented 3 years ago

Hello @TGotwig , I'm not quite sure what some other issues actually means, but I'm rather reluctant to rewrite the readme, but I could think of a wiki doc describing this. However, I currently do not have the time for this but I'd be happy to accept a PR for this ;-) The same holds true for the Makefile suggestions. Best regards!