Browse Source

Adds preliminary license and uses README.md

Andreas T. Meyer-Berg 6 years ago
parent
commit
dcff1f9f63
2 changed files with 96 additions and 0 deletions
  1. 76 0
      README.md
  2. 20 0
      license.md

+ 76 - 0
README.md

@@ -0,0 +1,76 @@
+# Holeg Simulator
+
+Cyber-physical systems simulation software following a Holon-based smart grid system.
+
+## Prerequisites
+
+* Java 1.7 compatible VM
+* Gradle >= 3.1 (may be downloaded on-the-fly)
+
+## Building
+
+This project uses Gradle. If Gradle is not available on your system, run the included shell 
+script `gradlew` (or `gradlew.bat` on Windows) instead of the `gradle` command.
+
+### Available tasks
+
+	$ gradle build		# Assembles and tests this project.
+	
+	$ gradle test		# Runs the included unit tests.
+	
+	$ gradle run		# Starts the Holeg Simulator as JVM Application.
+	
+	$ gradle tasks		# Displays all the tasks runnable from root project.
+
+## API Instructions
+
+See [LICENSE.md](LICENSE.md) for some Instructions
+
+## License
+
+This project is licensed under a modified MIT License - see the [LICENSE.md](LICENSE.md) file for details
+	
+## Built With
+
+* [JUnit](http://junit.org) - The used test system
+* [Gson](https://github.com/google/gson) - Used for Saving/Loading
+* [Apache Common Compress ](https://rometools.github.io/rome/) - Creates zip/tar Archives
+
+## Contributors
+
+### Version 1.0 to 1.1.0
+
+*  Kevin Julian Trometer
+*  Dominik Fabio Rieder
+*  Teh-Hai Julian Zheng
+*  Edgardo Ernesto Palza Paredes
+*  Jessey Steven Widhalm
+
+### Version 2.0
+
+*  Isabella Dix
+*  Carlos Garcia
+
+### Version TBA
+
+*  Andreas T. Meyer-Berg
+*  Ludwig Tietze
+*  Antonio Schneider
+*  Tom Troppmann
+
+## Under contract from:
+
+*  Darmstadt University of Technology
+*  Department of Computer Science, Telecooperation
+*  Hochschulstr. 10
+*  Informatik Telecooperation Lab (TK)
+*  D-64289 Darmstadt, Germany
+
+### Version 1.0 to 1.1.0
+
+*  Andreas Tundis
+*  Carlos Garcia
+
+### Version TBA
+
+*  Rolf Egert

+ 20 - 0
license.md

@@ -0,0 +1,20 @@
+# Copyright (c) 2017 <copyright holders>
+	
+	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.
+	
+	Except as contained in this notice, the name of the <copyright holders> shall not be used in 
+	advertising or otherwise to promote the sale, use or other dealings in this Software without
+	prior written authorization from the <copyright holders>.