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

Create a single-page quickstart with pointers to more detail in other sections #82

Open
jchodera opened this issue Apr 12, 2022 · 0 comments

Comments

@jchodera
Copy link
Member

jchodera commented Apr 12, 2022

A single-page "quickstart" (TL;DR) could help people easily identify the main ideas and identify gaps in their knowledge.
Consider making it easy for someone who is already knowledgeable to learn your practices very rapidly.

  • Use the cookiecutter to get started
  • We will use the MIT License because everyone can use our code then
  • Use latest Python
  • Use numpy docstring convention
  • Active GitHub Actions setting to get CI started
  • Here's how to easily deploy your docs
  • Here's how to deploy your code
@dotsdl dotsdl added this to the Revision 2022.04 milestone Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants