From fc8af5dff9f9ee510a230890e91fcd8e1bf764e7 Mon Sep 17 00:00:00 2001
From: Laurentiu Niculae <niculae.laurentiu1@gmail.com>
Date: Fri, 11 Oct 2024 11:58:52 +0300
Subject: [PATCH] Add README

---
 .gitignore |  3 ++-
 README.md  | 26 ++++++++++++++++++++++++++
 2 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index e022a63..1ed393c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .vscode
 .mvn
-target
\ No newline at end of file
+target
+target/*
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1dbda1e
--- /dev/null
+++ 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
+```
+