added readme

This commit is contained in:
Amazed 2021-10-19 00:37:12 +02:00
parent 38df9d27b9
commit 311ccb97d1

28
README.md Normal file
View File

@ -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`.