[README] - Added initial version of a README

README.md

@@ -0,0 +1,120 @@
+
+[![Girl Life](https://git.catrenelle.com/Crux/glife/raw/master-readme/docs/images/girllife-logo.png?v=3)](https://git.catrenelle.com/Kevin_Smarts/glife/)
+
+<h1 align="center">Girl Life</h1>
+
+A game about the simulated life of a woman containing elements of RPG, strategy, porn and magical combat. You may choose what kind of life the Player Character will live according to your play style, conscience or even personal beliefs.
+
+## Intended audience for this README
+
+This README can be found on the [Girl Life Repository](https://git.catrenelle.com/Kevin_Smarts/glife) and is intended for those who wish to contribute to the Girl Life project. You'll find this README focussed on getting you up (to speed) and running so you can maintain and develop on a local version of Girl Life.
+
+If you're looking for general information on the game, please refer to the [Girl Life General Information section](#girl-life-general-information).
+
+## Short Introduction
+
+This is a game based on the Russian game ЭТО by DeGross, played in QSP. On 8/4/15 the original game development came to an end and since then both Russian and English-speaking players have taken it upon themselves to expand the game. The English Community Version originally started as a translation project, but soon became a game on its own with its own unique content (while also implementing new events from the Russian versions).
+
+## Getting started
+
+### Join the Discord server!
+
+You can find us on the [Girl Life Discord server](https://discord.gg/28tw5sG). Drop in to say hi and find any answer you need on your questions. And maybe end up with more questions than you started out with.
+
+### Installing Git
+
+Girl Life uses [Git Version Control](https://git-scm.com/) to share and collaborate our projects. If you're new to GIT and/or version control, it would be useful to read up on it. There is a lot to find with a simple internet
+search but you might start out with the [official and free Git book](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control). To start out, you do not necessarily have to use Git but in the long run, it
+
+You can also get various software on Git. Those more familiar usually stick to command lines whereas newcomers find [graphical user interfaces](https://git-scm.com/downloads/guis) more easy to start out with.
+
+### Clone the Git repository
+
+Visit the [Girl Life Git repository](https://git.catrenelle.com/Kevin_Smarts/glife). If you're not using git you can download a ZIP file by clicking on the "download icon", to the right of the HTTPS and git URL
+
+Sign up to the Git repository on [https://git.catrenelle.com/](https://git.catrenelle.com/) and create a [Git "fork" of the main repository](https://git.catrenelle.com/Kevin_Smarts/glife/forks) which can be easily done via the web interface.
+
+Cloning the git repository in a GUI would mean copy pasting the git URL of your own fork repository into your Git client. For shell users:
+
+```bash
+# Using the main repo as an example, this will later be https://git.catrenelle.com/<your_username>/glife.git
+git clone https://git.catrenelle.com/Kevin_Smarts/glife.git
+cd glife
+```
+
+### Open a QSP Editor
+
+Quest Soft Player comes with an IDE (Editor software) called [QGen](https://github.com/rrockru/QtQGen) which you can find in the directory [glife/tools/QGen5/](https://git.catrenelle.com/Kevin_Smarts/glife/src/master/tools/QGen5) as a Windows executable QGen.exe
+
+Other people prefer to use [Notepad++](https://notepad-plus-plus.org/downloads/) which is far more powerful of an editor (moreso than meets the eye at first) and allows you to edit txt files instead. There is a 
+syntax highlighting file that can be found in [glife/tools/syntax/](https://git.catrenelle.com/Kevin_Smarts/glife/src/master/tools/syntax/) and you'll need the NoteplusPlus QSP2.xml. There is also support for [Visual Studio](https://visualstudio.microsoft.com/) or [Atom Editor](https://atom.io/)
+
+### Explore the project directory
+
+If you're familiar with interactive (or visual) novel software, than QSP might not be as new. QSP follows script that can be vary (branch) depending on variables which you can code for. If that is new to you, read up on the [this guide by Kevin Smarts](https://git.catrenelle.com/Kevin_Smarts/glife/wiki/Coding+guide). It is not entirely complete but one learns on the job. You 
+already joined the [Discord server](https://discord.gg/28tw5sG) of course so we're here to help.
+
+### Build your first glife.qsp file without modifying anything
+
+In the root directory of the repository is a MakeQSP.bat which is a Windows executable, the linux equivalent is build.sh. In Windows you can use your file explorer to navigate to your glife directory. Once there, you can click on File in the topleft corner and click on Open Windows Powershell. In this window: type
+```powershell
+.\MakeQSP.bat
+```
+
+And press enter. You'll be welcomed to an option menu.
+
+```powershell
+:: QSP Compiler and Launcher
+
+QGEN     : [OK] - "tools\QGen5\QGen.exe"
+QSP EXEC : [OK] - "tools\Player-video\qspgui.exe"
+QSP FILE : [OK] - "glife.qsp"
+COPY     : [DISABLED]
+
+
+ACTIONS: (B)uild  (R)un  (F)ull  (Q)Gen  (E)xit
+
+Choose an action:
+```
+
+Simply type b (lowercase) and press enter. The script will now build a playable glife.qsp file.
+
+### Run the QSP file in your Quest Player
+
+Of course the game requires images, so they should be accessible in the directory. You can either copy or symlink the image directories. However for a test run, this isn't required. If you haven't already done so, install the
+[Sonnix QSP Player (Video)](https://mega.nz/folder/dNRwkIyI#AaPPAV5UqPiXNaXiWtv1xg) which has required video support.
+
+Load the freshly generated QSP file into the Quest Player. Presto. You have created your first QSP game.
+
+### Next steps
+
+Read the more specific guidelines for Girl Life in our [glife/docs](https://git.catrenelle.com/Kevin_Smarts/glife/docs) directory. Be sure to explore, fiddle and try out. Also don't be afraid afraid to try (and fail) at first. We've all been there. Ask in the Discord where you can start out from or if you need any help.
+
+### Contribute to the project
+
+Sign up to the Git repository on [https://git.catrenelle.com/](https://git.catrenelle.com/) and create a [Git "fork" of the main repository](https://git.catrenelle.com/Kevin_Smarts/glife/forks) which can be easily done via the web interface.
+
+## Useful links
+
+### QSP Development
+
+- [Girl Life Git Repository](https://git.catrenelle.com/Kevin_Smarts/glife)
+- [QSP Coding Guide by Kevin Smarts](https://git.catrenelle.com/Kevin_Smarts/glife/wiki/Coding+guide)
+- [QSP Wiki (outdated)](http://www.ifwiki.org/index.php/QSP)
+- [QSP Github Repositories](https://github.com/QSPFoundation)
+
+### Quest Soft Player (QSP)
+
+- [Sonnix QSP Player (Video)](https://mega.nz/folder/dNRwkIyI#AaPPAV5UqPiXNaXiWtv1xg) [repository](https://gitlab.com/Sonnix1/Qqsp)
+- [Quest Player for Android (Video)](https://github.com/seedhartha/QuestPlayer/releases)
+
+### Girl Life General Information
+
+- [Girl Life on Discord](https://discord.gg/28tw5sG)
+- [Girl Life Wiki](https://sites.google.com/view/girllifewiki/home) *([currently looking for contributors](https://sites.google.com/view/girllifewiki/wiki-pages/how-to-contribute-to-the-wiki))*
+- [Girl Life on the TFGames Site](https://tfgames.site/index.php?module=viewgame&id=597)
+- [Girl Life section on the TFGames Site forum](https://tfgames.site/phpbb3/viewtopic.php?f=70&t=8271)
+- [Girl Life on F95Zone](https://f95zone.to/threads/girl-life-v0-8-1-3-kevin-smarts.411/)
+- [Girl Life FAQ on the Repository](https://git.catrenelle.com/Kevin_Smarts/glife/wiki/FAQ)
+
+