Skip to content
Update startup to give instructions for building under Windows with Cygwin (Issue #22) authored by Omid Roshan-Afshar's avatar Omid Roshan-Afshar
......@@ -39,6 +39,31 @@ If you want to join, but you're not sure how to get started:
+ Open main.tex with MiKTeX
+ Press the green 'play' button.
### Cygwin
If you want to replicate a *nix-style workflow on a Windows platform, the following setup may work for you:
+ Install [Cygwin](https://www.cygwin.com/) making sure to select the git and make packages.
* If you wish to use SSH for git access, instead of HTTPS, then add the openssh package also
+ Open up the Cygwin bash console so that it can create a home folder within it's folder structure for you.
+ Download the Windows binary for [git-lfs](https://github.com/git-lfs/git-lfs/releases) and place the executable in a location that is in the PATH. One option is to create a "bin" subfolder in your Cygwin home folder and add it to your path by editing `.bash_profile`. You could also place it elsewhere on your filesystem and just edit the Windows PATH environment variable in order to add that location.
+ Install [TeX Live](https://www.tug.org/texlive/windows.html)
+ Install [Inkscape](https://inkscape.org/release)
+ From a **newly opened** Cygwin bash console and clone the repo with one of the following commands:
* `git clone git@gitlab.com:bindrpg/core.git`
* `git clone https://gitlab.com/bindrpg/core.git`
+ Then execute the following commands:
* `cd core`
* `make`
The above process should build the Core Rulebook. If you wish to execute the build of the `config` repository itself, there is one additional step that will be required. Typical Windows installations do not support symlinks. The config repository utilizes a symlink in order to emulate the folder structure of the other document repositories. At the top of the config repo, you will find a symlink named "config" that points to the config repo folder itself. In order to execute builds of the `config` repo on Windows, execute the following commands before `make`:
+ `cd config`
+ `rm config`
+ `mkdir config`
+ `shopt -s extglob`
+ `cp -R !(config) config/`
+ `make`
# Learning Git
If you modify a weapon and someone else adds a spell, nobody wants to deal with merging those two ideas together. Git puts your changes together for you.
......
......