Skip to content
This repository has been archived by the owner on Mar 25, 2019. It is now read-only.

Improved README.md? #176

Open
murraycu opened this issue Jul 21, 2014 · 0 comments
Open

Improved README.md? #176

murraycu opened this issue Jul 21, 2014 · 0 comments

Comments

@murraycu
Copy link
Contributor

It would be nice if the README file briefly described what the module is instead of just starting with how to install it. Most zooniverse repositories seem to have this problem.

For instance, the GalaxyZoo module seems to be the galaxyzoo.org website itself. The README could briefly describe the structure, mentioning the use of the various programming languages and techniques, maybe mentioning some of the high-level path through the code as a user classifies a galaxy. This would help casual contributors.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant