浏览代码

Improves README.md

* Additional information inside the README.md were added
* Gradle Tasks were listed
Andreas T. Meyer-Berg 5 年之前
父节点
当前提交
7e9b48541d
共有 1 个文件被更改,包括 20 次插入2 次删除
  1. 20 2
      README.md

+ 20 - 2
README.md

@@ -2,8 +2,26 @@
 
 Smart Home Network Simulation for Visualisation and Generation of IoT/SmartHome Network traffic
 
+## Gradle tasks
+Gradle will download required libraries and handle the build process
+
+	$ gradlew build		# Assembles and tests this project
+	
+	$ gradlew jar 		# Creates an executable Jar-file
+	
+	$ gradlew test		# Runs the included unit tests
+	
+	$ gradlew run		# Runs the SmartHomeNetworkSim as a JVM Application
+	
+	$ gradlew runIt		# Runs the SmartHomeNetworkSim as a Jar-file
+	
+	$ gradlew tasks		# Displays further available tasks
+
+## Required Libraries 
+
+* [Pcap4j](https://www.pcap4j.org/) - Java Library used for Pcap File creation (not yet implemented)
+
 <!-- comment -->
 
 ## Developed by
-Andreas T. Meyer-Berg
-
+Andreas T. Meyer-Berg (As part of his Bachelor Thesis)