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

Better README #4

Open
3 of 4 tasks
devinmatte opened this issue Jul 16, 2018 · 1 comment
Open
3 of 4 tasks

Better README #4

devinmatte opened this issue Jul 16, 2018 · 1 comment

Comments

@devinmatte
Copy link
Member

devinmatte commented Jul 16, 2018 •
edited by mbillow
Loading

As the beginning of the year approaches, freshman will soon try to look at and contribute to CSH projects. It's a bit hard when there are no setup instructions, or links of where to download python, pip, or any other tools we use.
It would be a good idea to add to the README some setup and other useful information

  • Setup information
  • System Dependencies
  • Python version, potentially as a badge Python 3.6
  • Code standards (Less important if pylint is present)
@mbillow
Copy link
Member

mbillow commented Sep 4, 2020

Added dependencies in the form of docker compose file and added local dev setup instructions.

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
2 participants
@mbillow @devinmatte