Add README

laurentiuNiculae · Oct 11, 2024 · fc8af5d · fc8af5d
1 parent 6b19a29
commit fc8af5d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .vscode
 .mvn
-target
+target
+target/*
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+#  Simple Animation Rendering Library
+
+
+## External Dependecies:
+You will need to install [Raylib](https://github.com/CreedVI/Raylib-J/releases/tag/v0.5.2) and [Processing](https://processing.org/download) jars in your local repository. After you downloaded the library jar you can use this command:
+
+```bash
+$ mvn install:install-file -Dfile=./core/library/core.jar -DgroupId=org.processing -DartifactId=core -Dversion=4.0.0 -Dpackaging=jar
+```
+
+Same for the raylib jar.
+
+## Build
+
+Build a jar
+
+```bash
+$ mvn package
+```
+
+Then run it 
+
+```bash
+$ java -jar ./target/animation-renderer-lib-2.0.0.jar
+```
+