From 021c63cf987932db661c8459ab73c0217cd9f2e3 Mon Sep 17 00:00:00 2001
From: OLEGSHA <kvadropups@gmail.com>
Date: Wed, 29 Jul 2020 12:56:19 +0300
Subject: [PATCH] Created README.md

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0c5a29a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Optica
+A free, open source sandbox survival game currently in early development.
+
+## Contributing
+
+For now, contact @Javapony in Telegram for details. Contributing is completely allowed, but we don't have any set guidelines yet.
+
+## Building
+
+1. `$ git clone https://github.com/OLEGSHA/Optica.git`
+2. `$ gradlew build`
+
+### Additional setup for Eclipse IDE
+
+If you have Buildship plugin installed, use File - Import - Gradle - Existing Gradle Project. Main class is `ru.windcorp.optica.client.OpticaClientMain`.
+
+Alternatively do the following:
+
+1. Add `id 'eclipse'` into `build.gradle` inside `plugins { ... }`:
+```
+plugins {
+    // Apply the java-library plugin to add support for Java Library
+    id 'java-library'
+    id 'eclipse'
+}
+```
+2. `$ gradlew eclipse`
+3. Import the project with File - Import - Existing Projects into Workspace
+
+### Additional setup for IntelliJ IDEA
+
+1. Add `id 'idea'` into `build.gradle` inside `plugins { ... }`:
+```
+plugins {
+    // Apply the java-library plugin to add support for Java Library
+    id 'java-library'
+    id 'idea'
+}
+```
+2. `$ gradlew idea`
+3. Open the project with File - Open Project
+
+## Libraries
+
+* LWJGL - OpenGL, OpenAL, GLFW and several more libraries ported to Java
+* Google Guava
+* Trove4j
+* java-graphics/glm - GLM ported to Java. _Maven Central contains an outdated version, a custom repository used instead_
+* Apache Commons Math (_not currently used_)