Skip to content

Commit

Permalink
📚 add README_template
Browse files Browse the repository at this point in the history
  • Loading branch information
ressl committed Apr 17, 2018
1 parent e6400bd commit eba0776
Showing 1 changed file with 90 additions and 0 deletions.
90 changes: 90 additions & 0 deletions README_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Project Title

One Paragraph of project description goes here

## Getting Started

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.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* [chef](https://www.chef.io) - Chef Software, Inc

## Contributing

Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Robert Ressl** - *Initial work* - [Robert Ressl](https://github.com/safematix)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the GNU Affero General Public License v3.0 License - see the [LICENSE](LICENSE) file for details

## Acknowledgments

* Hat tip to anyone who's code was used
* Inspiration
* etc

## Thanks to…

* People who helped you.
* Persons you have taken code from

0 comments on commit eba0776

Please sign in to comment.