README.md

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