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

Unify README and introductory documentation #37

Open
exarkun opened this issue Jun 12, 2014 · 0 comments
Open

Unify README and introductory documentation #37

exarkun opened this issue Jun 12, 2014 · 0 comments
Labels
enhancement ready
Milestone
0.3.0

Comments

@exarkun
Copy link
Member

exarkun commented Jun 12, 2014

The purpose of the README is essentially to hook potential users with compelling informational about what and why machinist is. This same material should be presented at the beginning of the other documentation machinist comes with - the stuff in doc that will end up on readthedocs.org and be experienced by people discovering the project without going via the README.

Suggested #32 (diff)
@itamarst itamarst added this to the 0.3.0 milestone Jan 27, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement ready
Projects
None yet
Milestone
0.3.0
Development

No branches or pull requests
2 participants
@exarkun @itamarst