Added table of contents

[xonotic/xonotic.wiki.git] / SMB-modpack.md

diff --git a/SMB-modpack.md b/SMB-modpack.md
index ac65fd433644cb059b0b451f507732a58742750c..1802d4b7ec43ed8dfd7f612e686f4579c903bf4e 100644 (file)
--- a/SMB-modpack.md
+++ b/SMB-modpack.md
@@ -4,9 +4,11 @@ The modpack build works using a submodule from '_xonotic-dat.pk3dir_' from the o
 
 Uses **update.sh** and **build.sh** shell script files. 
 
+# How submodule works, ./update.sh and ./build.sh
+
 Uses '_update.sh_' to obtain the content of '_gmqcc_', '_xonotic-data.pk3dir_' in '_xonotic_' folder and '_csprogs_' in '_.cache_' folder. Clearly, needs gmqcc to be able to compile, this means that '_build.sh_' calls gmqcc to compile the code.
 
-<br/>
+## Submodule and ./update.sh
 
 The submodule of this modpack was created using: 
 
@@ -17,26 +19,27 @@ The submodule in the repository is used when need to update the code from '_xono
 `git submodule update --remote --merge`
 
 It'll update the content where is in the official gamelogic development repository in your modpack repository.
-*(Additionally, after done this, if you do the commit:*
 
-*`git status`*
+Inside '_update.sh_', there is a line: 
+
+`git submodule update --init --depth 100`
 
-*`git add xonotic`*
+Means that when you use '_./update.sh_' with this line, the submodule content will be downloaded in your local computer where you've cloned the modpack repository.
 
-*`git commit -m "Update submodule xonotic test"`*
+### Commit with submodule
 
-*`git push origin master #depends what origin and what branch you're using to do your commits`*
+Additionally, after done `git submodule update --remote --merge`, if you want to commit:
 
-*)*
+`git status`
 
-Inside '_update.sh_', there is a line: 
+`git add xonotic`
 
-`git submodule update --init --depth 100`
+`git commit -m "Update submodule xonotic test"`
 
-Means that when you use '_./update.sh_' with this line, the submodule content will be downloaded in your local computer where you've cloned the modpack repository.
+`git push origin master #depends what origin and what branch of repository you're using to do your commits`
 
-<br/>
+## ./build.sh
 
 '_./build.sh_' compiles all repository code using gmqcc if already downloaded from '_./update.sh_', looks inside '_mod_' folder the similar contents of '_xonotic-data.pk3dir/qcsrc_' where there are: '_client_', '_common_', '_menu_' and '_server_' folders.
 
-What it does is relate the directory path to the submodule '_xonotic_' directory inside the '_qcsrc_' folder. Thanks to this, it makes it possible to look at the '_mod_' folder having to relate the submodule directory '_xonotic/qcsrc_'.
\ No newline at end of file
+What this does is relate the directory path to the submodule '_xonotic_' directory inside the '_qcsrc_' folder. Thanks to this, makes possible to look at the '_mod_' folder having to relate the submodule directory '_xonotic/qcsrc_'.
\ No newline at end of file