Commit 812f6cfddf9f79a6aa11f7387f8c1ed7e091c617

Authored by Louis Baetens
1 parent b9e0e21e
Exists in master

add a readme

Showing 1 changed file with 53 additions and 0 deletions   Show diff stats
PCC/readme.md 0 → 100644
... ... @@ -0,0 +1,53 @@
  1 +# Project Title
  2 +
  3 +One Paragraph of project description goes here
  4 +
  5 +## Getting Started
  6 +
  7 +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
  8 +
  9 +### Prerequisites
  10 +
  11 +What things you need to install the software and how to install them
  12 +
  13 +```
  14 +Give examples
  15 +```
  16 +
  17 +### Installing
  18 +
  19 +A step by step series of examples that tell you how to get a development env running
  20 +
  21 +Say what the step will be
  22 +
  23 +```
  24 +Give the example
  25 +```
  26 +
  27 +And repeat
  28 +
  29 +```
  30 +until finished
  31 +```
  32 +
  33 +End with an example of getting some data out of the system or using it for a little demo
  34 +
  35 +## Running the tests
  36 +
  37 +Explain how to run the automated tests for this system
  38 +
  39 +### Break down into end to end tests
  40 +
  41 +Explain what these tests test and why
  42 +
  43 +```
  44 +Give an example
  45 +```
  46 +
  47 +### And coding style tests
  48 +
  49 +Explain what these tests test and why
  50 +
  51 +```
  52 +Give an example
  53 +```
... ...