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

Repo cleanup actions #2

Closed
4 tasks done
rvosa opened this issue Feb 8, 2023 · 5 comments
Closed
4 tasks done

Repo cleanup actions #2

rvosa opened this issue Feb 8, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@rvosa
Copy link
Member

rvosa commented Feb 8, 2023

  • Merge development branch into main, delete dev branch
  • Use actual tagged versions instead of version numbers in commits or code files
  • Commit to hybpiper wrapper, delete distribute_reads_to_targets
  • Write README documentation
@rvosa rvosa added the documentation Improvements or additions to documentation label Mar 23, 2023
@rvosa
Copy link
Member Author

rvosa commented Mar 23, 2023

The documentation still needs to be expanded more. To be specific:

  1. How to install. A person who administers the portal but knows nothing about hybpiper needs to know what to do. Maybe run this by Edwin.
  2. How to use. Once installed, what does Sylvia need to run an analysis?

@Eremus007 Eremus007 reopened this Mar 23, 2023
@Eremus007
Copy link
Collaborator

Did you also see the readme's in the /tools directory, and are we talking about those specifically? I wrote a general readme for the repo and then additional .md files going into detail for every tool.

And I think both of those readmes adress that issue

@Eremus007 Eremus007 reopened this Mar 23, 2023
@Eremus007
Copy link
Collaborator

/continue (accidentally pressed enter)

Should I merge the different readme's into one?

@rvosa
Copy link
Member Author

rvosa commented Mar 23, 2023

Maybe link to them from the top level or give a brief layout of the repo to show where more info can be found.

@Eremus007
Copy link
Collaborator

Yes, will do!

@rvosa rvosa closed this as completed Mar 31, 2023
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
Projects
None yet
Development

No branches or pull requests

2 participants