Skip to content

Instantly share code, notes, and snippets.

@gistfrojd

gistfrojd/README-stub.md

Last active March 24, 2016 07:49
Show Gist options
  • Save gistfrojd/75b7868fe43a516ea2ec to your computer and use it in GitHub Desktop.
Save gistfrojd/75b7868fe43a516ea2ec to your computer and use it in GitHub Desktop.
Download ZIP
README.md project stub (this file has moved to https://github.com/Frojd/Manual)
Raw
README-stub.md

Project name

A short introduction to your project here, what it is built in and what cms/framework etc it is using.

Requirements

This section is optional if there isn't any special dependencies. Else a bulletlist will suffice, e g:

  • Node.js
  • Mongodb
  • Amazon S3 access

Installation

A quick guide on how to install your project. For example:

  1. Download the repo to your webserver
  2. Run npm install
  3. Install database
  4. Edit config.conf with your database settings
  5. Visit your new site!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment