Skip to content

Instantly share code, notes, and snippets.

@rosswintle

rosswintle/README.standard.md

Last active August 29, 2015 14:00
Show Gist options
  • Save rosswintle/11038520 to your computer and use it in GitHub Desktop.
Save rosswintle/11038520 to your computer and use it in GitHub Desktop.
Download ZIP
Standard README for collaborative web projects
Raw
README.standard.md

PROJECT NAME

a Project - http://url.co.uk

Last Updated: DD/MM/YYYY

Contents:

  1. Purpose of this file
  2. Authors/contributors
  3. How to compile/build
  4. Frameworks, templates and tools used with references
  5. Development notes

Purpose of this file

This file is intended to document the tools and frameworks used on a project and how to build that project.

It's intended to help a new developer come along and pick up the project, and to act as a reminder to existing developers of how to build the project should updates need to be done.

This file is written in Markdown

Note that this file MAY be downloadable and readable to both humans and bots. Be careful what you say!

Authors/contributors

Author Name - Position - Company

How to compile/build

You will need compass.

> cd library/scss
> compass watch

Frameworks, templates and tools used with references

This theme is based on v1.25 of "Bones": a mobile-first, responsive WordPress starter theme.

See:

The theme is built using Compass (an extension of SASS), which you will need to have installed, and there is a config.rb file for Compass in library/scss

Development notes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment