Improve the readme - Githubissues

nf-modules-hub / gzip

Nextflow wrapper for gunzip

MIT License

0 stars 1 forks source link

Improve the readme #5

Open abhi18av opened 4 years ago

abhi18av commented 4 years ago

@sharma-shruti , let's try to improve the quality of readme on this, from the perspective of the first time user.

Let's give it a shot we'll discuss more on the PR itself.

abhi18av commented 4 years ago

@sharma-shruti , I've merged the PR #6 regarding the code documentation.

For the user documentation, let's make a push and take feedback from @Ankita-1211 .

Ankita-1211 commented 4 years ago

@abhi18av @sharma-shruti Just went through the script. Yes the readme needs some improvisation. First time experience is , it's confusing .

Why need of point 3.

Let's discuss more in this.

abhi18av commented 4 years ago

Thanks for the quick revert @Ankita-1211 !

I've updated the user-documentation i.e. the Readme.md file and separated the code-documentation which is now inside the main.nf

This was done via https://github.com/nextflow-hub/trimmed_gunzip_fqgz/commit/498a985fa1f34c07a8a293ef4d82f283f156f107

abhi18av commented 4 years ago

I've made other changes as well, here's the summary

abhi18av commented 4 years ago

TODO: add an index to the readme

Ankita-1211 commented 4 years ago

This is good.

@abhi18av Could you please explain to me why options part of readme has "trimmed untrimmed." In Bioinfo, these term are used for trimming a data having adapters.

Utility still confuses me. The header says "wrapper for gunzip"**.

abhi18av commented 4 years ago

Hmm, @Ankita-1211 , I thought that it might be helpful that way - but apparently not.

Okay, let us @sharma-shruti @Ankita-1211 and @abhi18av connect this weekend about this. We would also present you with more of our ideas regarding the options.