Commit cba457c5 authored by adud's avatar adud

add installation guide (copied from README.md)

parent 384a4145
......@@ -2,3 +2,37 @@
Installation Guide
====================
Avatar ENSignes runs with the `Godot Game Engine <https://godotengine.org>`_.
Installing Godot
----------------
On Windows:
^^^^^^^^^^^
Install the binary from `Godot website
<https://godotengine.org/download/windows>`_.
On MacOS:
^^^^^^^^^
The easiest way is to install it with brew: ``brew cask install godot``
On Linux
^^^^^^^^
+ Ubuntu: The easiest way is to use Ubuntu snaps: ``sudo snap install godot``
+ Fedora: ``yum install godot``
+ Archlinux: Godot is available in the AUR::
cd /tmp
git clone https://aur.archlinux.org/godot.git & cd godot
makepkg -si
Install project dependancies
----------------------------
+ ``yaml-cpp``
+ Ubuntu: ``sudo apt-get install yaml-cpp``
+ Archlinux: ``pacman -S yaml-cpp``
+ MacOS: ``brew install yaml-cpp``
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment