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.

Sign up for GitHub

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

Jump to bottom

Polish README #879

Open
fengelniederhammer opened this issue Jul 31, 2024 · 0 comments
Open

Polish README #879

fengelniederhammer opened this issue Jul 31, 2024 · 0 comments

Comments

@fengelniederhammer
Copy link
Contributor

Before announcing an official release, we should polish the README:

  • provide a catchy summary that explains in very few sentences what SILO does.
  • provide an overview over the repo content / subdirectories
  • provide TLDRs on how to get started using LAPIS
  • provide TLDRs on how to get started developing LAPIS
  • possibly move some of the current content to dev docs / contributing / similar...

(Similar to GenSpectrum/LAPIS-SILO#528)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fengelniederhammer