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

Make README builder #26

Open
23 tasks
jsbean opened this issue Aug 28, 2018 · 0 comments
Open
23 tasks

Make README builder #26

jsbean opened this issue Aug 28, 2018 · 0 comments

Comments

@jsbean
Copy link
Member

jsbean commented Aug 28, 2018

A README.md for a Github repository has very similar requirements to that for the API Reference. However, there are enough differences to make this seem like they should be compiled from more elemental sources.

For each level where a README should reside, move it to Documentation and split it up into the following parts:

  • Tagline
  • Overview
  • Usage
    • Requirement
    • Installation
  • Development
    • Clone
    • Architecture
  • Inspiration

The Github version will compose the following together:

  • Tagline
  • Overview
  • Usage
  • Requirement
  • Installation
  • Development
    • Clone
    • Architecture
  • Inspiration

While the API Reference version will compose the following together:

  • Tagline
  • Overview
  • Usage
  • Architecture
  • Inspiration
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
1 participant
@jsbean