README.md

   1 <!--
   2 Licensed under the Apache License, Version 2.0 (the "License");
   3 you may not use this file except in compliance with the License.
   4 You may obtain a copy of the License at
   5
   6    http://www.apache.org/licenses/LICENSE-2.0
   7
   8 Unless required by applicable law or agreed to in writing, software
   9 distributed under the License is distributed on an "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  11 implied.
  12 See the License for the specific language governing permissions and
  13 limitations under the License
  14 -->
  15 # Project Title
  16
  17 One Paragraph of project description goes here
  18
  19 ## Getting Started
  20
  21 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.
  22
  23 ### Prerequisites
  24
  25 What things you need to install the software and how to install them
  26
  27 ```
  28 Give examples
  29 ```
  30
  31 ### Installing
  32
  33 A step by step series of examples that tell you how to get a development env running
  34
  35 Say what the step will be
  36
  37 ```
  38 Give the example
  39 ```
  40
  41 And repeat
  42
  43 ```
  44 until finished
  45 ```
  46
  47 End with an example of getting some data out of the system or using it for a little demo
  48
  49 ## Running the tests
  50
  51 Explain how to run the automated tests for this system
  52
  53 ```
  54 Give an example
  55 ```
  56
  57 ## Deployment
  58
  59 Add additional notes about how to deploy this on a live system
  60
  61 ## Built With
  62
  63 * [Python](www.python.org/) - The language used
  64
  65 ## Contributing
  66
  67 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
  68
  69 ## Versioning
  70
  71 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://osm.etsi.org/gitweb/?p=osm/TEMPLATE.git;a=tags).
  72
  73 ## License
  74
  75 This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details
  76
  77 ## Acknowledgments
  78
  79 * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
  80