X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;fp=README.md;h=9f1db339f58ddd6615d8f1452170b5cb13392e92;hb=3b7a5ed3ebdf3bb5a6211c88099fa8dd1a0552c6;hp=0000000000000000000000000000000000000000;hpb=390300e390d4d04db172d5c3d71ae3f6b322d313;p=osm%2FNG-UI.git diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f1db33 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ + +# 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 how 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 + +``` +Give an example +``` + +## Deployment + +Add additional notes about how to deploy this on a live system + +## Built With + +* [Python](www.python.org/) - The language used + +## Contributing + +Please read [CONTRIBUTING.md](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://osm.etsi.org/gitweb/?p=osm/NG-UI.git;a=tags). + +## License + +This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details +