Readme for GitHub

[masakudamatsu]

See https://www.evernote.com/l/AFNzWXPxOURB9qKTzBZabDKHYFPtnMliDpc

https://gist.github.com/jxson/1784669

• Synopsis
  • what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
• Code example
  • Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example.
• Motivation
  • why the project exists.
• Installation
  • how to get the project.
• API Reference
  • a link to where the API reference docs live.
  • if it is small and simple enough the reference docs can be added to the README.
• Test
  • how to run the tests with code examples.
• Contributors
  • how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
• License
  • A short snippet describing the license (MIT, Apache, etc.)

Technologies used APIs used

Purpose

• an employer is likely not going to clone an application or spend an extensive amount of time going through the code so a README should provide information about a project.

[masakudamatsu]

A quick version is written up: https://github.com/masakudamatsu/line-height-picker/commit/c81e4dfa007241716c2bc7cb9d4cb039335f6b61

[masakudamatsu]

Refer to https://github.com/hsluv/hsluv as an example