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

Improve documentation #29

Open
bwillis opened this issue Mar 17, 2014 · 0 comments
Open

Improve documentation #29

bwillis opened this issue Mar 17, 2014 · 0 comments
Assignees
@bwillis
Labels
enhancement

Comments

@bwillis
Copy link
Owner

bwillis commented Mar 17, 2014

The README file is a beast and I am considering how to split it up and how to present it.

Where to present it:

Sections:

  • Get started
  • Change log
  • Comparison
  • Testing
  • Configuration
  • Error handling
  • Philosophy
@bwillis bwillis self-assigned this Mar 17, 2014
@bwillis bwillis added this to the v3 milestone Jan 20, 2015
@bwillis bwillis modified the milestones: v3, v4 May 8, 2017
@bwillis bwillis removed this from the v4 milestone Mar 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bwillis bwillis

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bwillis