|
@@ -1,4 +1,37 @@
|
|
|
-:: Reference
|
|
|
+:: ReferenceNavigation[include]
|
|
|
+
|
|
|
+:: Reference[menu]
|
|
|
+<h2>First Steps</h2>
|
|
|
+Prerequisites:
|
|
|
+<ul>
|
|
|
+ <li>Have Python 3.x installed. Make sure it is added to PATH (there is a checkbox you have to check in the installer).</li>
|
|
|
+ <li>Have GIT installed. It also needs to be included in PATH.</li>
|
|
|
+ <li>Have an IDE installed (VSCode is recommended).</li>
|
|
|
+</ul>
|
|
|
+Then:
|
|
|
+<ol>
|
|
|
+ <li>Create an account at https://git.tfgames.site </li>
|
|
|
+ <li>Create a fork of https://git.tfgames.site/StephanFuchs/glife </li>
|
|
|
+ <li>Clone the fork to your device (one way is the clone-command of git ... there are tutorials out there that explain that better than I could).</li>
|
|
|
+ <li>Run the file <i>sugarcube_compile.bat</i>. This will create the file <i>glife.html</i> for you. You can open it in any browser. Repeat this step after you made changes to the source code.</li>
|
|
|
+ <li>Make changes to the source code.</li>
|
|
|
+ <li>Commit the changes of your source code once you are happy with them.</li>
|
|
|
+ <li>Make a pull-request if you think your changes qualify to be pulled.</li>
|
|
|
+</ol>
|
|
|
+
|
|
|
+<h2>Branches</h2>
|
|
|
+In the main repository (https://git.tfgames.site/StephanFuchs/glife), there are the following branches:
|
|
|
+<ul>
|
|
|
+ <li>SC-Master: This is master branch. The goal is to only have finished code here.</li>
|
|
|
+ <li>master: The working branch with functional but incomplete or unfinished code.</li>
|
|
|
+ <li>Edited-QSP*: Changes to the QSP-source before the automatic translate-script runs over it.</li>
|
|
|
+ <li>Edited-TW: Changes to the Twine-files right after the translate-script runs over the code.</li>
|
|
|
+ <li>SC-Releases: Release Versions.</li>
|
|
|
+ <li>Everything else: Deprecated branches that could still have some valuable pieces hidden somewhere.</li>
|
|
|
+</ul>
|
|
|
+
|
|
|
+
|
|
|
+:: Reference_deprecated[deprecated]
|
|
|
<h2>Reference</h2>
|
|
|
<h3>Compiling</h3>
|
|
|
<p>The game is compiled by running <i>sugarcube_compile.bat</i>.</p>
|