commit 3628c642f1de8c631126b54b93118286872eb3e2
parent 0b2ded8c445709ef71f5869b4e2d73d39ad959a1
Author: MTRNord <mtrnord1@gmail.com>
Date: Sun, 12 Jun 2016 20:59:08 +0200
Add some Documentation
Diffstat:
| A | LICENSE | | | 21 | +++++++++++++++++++++ |
| A | README.md | | | 72 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 93 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016, MTRNord.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,72 @@
+# Project Street
+
+Secret Project (WIP)
+
+## 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.
+
+### Prerequisities
+
+What things you need to install the software and how to install them
+
+```
+1. Get an Raspberry Pi with PiCamera
+
+2. Install some software: sudo apt-get install libopenvc-dev build-essentials clang automake autoconf make
+```
+
+### Installing
+
+A step by step series of examples that tell you have to get a development enviroment running
+
+First configure the Project by running
+
+```
+./configure
+```
+
+Than run
+
+```
+make
+```
+
+If you wan't to install it global you have to run
+
+
+## Running the tests
+
+No Tests at this time implemented.
+
+## Deployment
+
+To install it on an live system just run
+
+```
+make install
+```
+
+## Built With
+
+* OpenCV
+* Automake
+* C++
+
+## 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://github.com/MTRNord/project_street/tags).
+
+## Authors
+
+* **Marcel <MTRNord>** - *Initial work* - [MTRNord](https://github.com/MTRNord)
+
+See also the list of [contributors](https://github.com/MTRNord/project_street/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
