search

prophyle / prophex

ProPhex – an exact k-mer index using Burrows-Wheeler Transform
MIT License
6 stars 1 forks source link

Extend readme #3

Closed salikhov-kamil closed 6 years ago

karel-brinda commented 6 years ago

Great, the readme overall looks good. Could you just add automatic readme regeneration (to the main Makefile), please? If we change any parameter in the program, we have to modify the readme manually which gets eventually very time consuming and annoying.

This is how I did it for SAMsift: https://github.com/karel-brinda/samsift/blob/44eef16502ffb5f7faf45fc4a65da906418b3166/Makefile#L27

You can use almost the same code. It only needs to be adjusted for .md (SAMsift readme is in .rst).

salikhov-kamil commented 6 years ago

Yes, I'll do that, Karel.

salikhov-kamil commented 6 years ago

Karel, let's merge this branch. I'll do the automatic regeneration of Readme during work on the renaming of commands (prophex index -> prophex klcp etc), as it will be easy to check that it works too