Hacker News new | ask | show | jobs
by dfc 4445 days ago
I don't know, the documentation is excellent. That is certainly one of the best READMEs I have ever seen. The organization of the setup sction of the README is superb. The author of the README clearly thought about the needs of new users as well as seasoned veterans. More projects need to adopt this general format:

  # Getting Started

  ## Quick Start

  If you are unsure of our project and just want to play around, you can
  get things set up quickly by:

  1.  Clone this repository and…
  2.  Do something
  3.  Do the other thing

  If you need more detailed instructions, have no fear. We are not going
  to look down on you if you are not an expert. We took the time to write
  a setup guide for newcomers: [Novice setup guide][novice-setup-guide].
  Everybody has to start somewhere.

  ## Real Start

  Follow these instructions if you wish to deploy your own version or
  contribute back to the project. There is nothing we hate more than
  README’s that ignore all of the practical concerns related to setting up
  a long term installation. Follow these steps and it will be easy for you
  to keep up with updates to the project and still retain the all tweaks
  you made to suit your idiosyncrasies.

  ## Odds and Ends

  ### Optional features

  Not everybody needs a XYZ plugin or wants to share their every action
  with PQR. You can enable these features by…

  ### Rare Corner cases

  In certain rare circumstances you made need to prevent X or implement Y.

  Prevent X by…

  If you need to implement Y…