Merge pull request #33 from jonx8/project_config

Add installation guide
jonx8 · Jan 2, 2024 · 1f9983d · 1f9983d
2 parents d15b3ef + 641fbe7
commit 1f9983d
Showing 1 changed file with 23 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# petCI
-Simple continuous integration system on Java
+# petCI 
+**petCI** - Simple continuous integration system on Java. 
+
+## Requirements:
+- JDK17
+- Linux
+
+
+## Installation
+
+1. **Clone repository to your computer**
+
+    ```$ git clone https://github.com/jonx8/petCI.git && cd petCI```
+
+2. **Build**
+    ```$ ./mvnw package``` or
+
+    if you have Maven installed on your computer  
+    ```$ mvn package```
+4. **Created link to the petci.sh in /usr/bin [Recommended]**
+
+    ```$ sudo ./install.sh```
+