Procházet zdrojové kódy

Added explanation on how to clone the code

Florian DORMONT před 10 roky
rodič
revize
7eb0e4587c
1 změnil soubory, kde provedl 17 přidání a 0 odebrání
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -2,6 +2,23 @@
 
 A J-RPG engine for the TI-Nspire. There's still a lot of work before anything works.
 
+## Getting the code wih Git
+To have the whole WRPG source code and its dependancies, and be able to compile and rock on, you have two options : using `--recursive` to download the whole repo and sub-modules or downloading the moduels after cloning the repo : 
+
+```bash
+# Download the whole repo and its submodules in one step
+git clone --recursive <WalrusRPG repo location>
+```
+
+Second option
+
+```bash
+git clone <WalrusRPG repo location
+cd <WalrusRPG folder>
+git submodule init
+git submodule update
+```
+
 ## Compiling
 
 The build system currently depends on Vogtinator's [ConvertImg](https://github.com/Vogtinator/ConvertImg),