Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the readme #5

Open
abhi18av opened this issue Jul 9, 2020 · 7 comments · Fixed by #6
Open

Improve the readme #5

abhi18av opened this issue Jul 9, 2020 · 7 comments · Fixed by #6
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@abhi18av
Copy link
Member

abhi18av commented Jul 9, 2020

@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.

@sharma-shruti sharma-shruti linked a pull request Jul 10, 2020 that will close this issue
@abhi18av
Copy link
Member Author

@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
Copy link

@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
Copy link
Member Author

abhi18av commented Jul 13, 2020

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 498a985

@abhi18av
Copy link
Member Author

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

image

@abhi18av
Copy link
Member Author

TODO: add an index to the readme

@abhi18av abhi18av added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 13, 2020
@Ankita-1211
Copy link

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
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants