From 311ccb97d1fbd02c9fd3df5e3f5f01e017dac9e8 Mon Sep 17 00:00:00 2001
From: Hipstercat <tasty@hipstercat.fr>
Date: Tue, 19 Oct 2021 00:37:12 +0200
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..ba40c8c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+Giants: Godot Edition
+=====================
+---------------------
+# Disclaimer
+Giants: Godot Edition is a fan-made remake. It has no affiliation with Planet Moon or Interplay.
+
+# How to setup
+1. Install Godot
+    - From [Steam](https://store.steampowered.com/app/404790/Godot_Engine/) (easiest)
+    - From the [official website](https://godotengine.org/download)
+2. Install Git
+    - For Windows: [here](https://git-scm.com/download/win)
+    - For Ubuntu/Debian: `apt install git`
+    - For other distributions: you know how to install it
+3. Install Git LFS
+    - For Windows: [here](https://git-lfs.github.com/)
+    - For Ubuntu/Debian: `apt install git-lfs`
+    - For other distributions: you know how to install it
+4. Clone this repository
+   ```sh
+   # Clone the repository (downloads all the base files)
+   git clone https://hipstercat.fr/gogs/hipstercat/giants-godot
+   cd giants-godot
+   
+   # Fetch large files (downloads all assets etc, might take an hour)
+   git lfs checkout
+   ```
+5. Open Godot Engine, click Import in the Project Manager window, then browse to `project.godot`.