Skip to content
Snippets Groups Projects
Unverified Commit b29ea4b1 authored by Malin Freeborn's avatar Malin Freeborn
Browse files

update readme

parent 442039cb
Branches
Tags
No related merge requests found
......@@ -2,15 +2,13 @@ These config files make the BIND RPG books look and act the way they do.
# Usage
To make a book, put this config folder into the same directory.
To make a book, start a git, then do:
> git subtree add -P config git@gitlab.com:bindrpg/config.git master
> git submodule add https://gitlab.com/bindrpg/config config
Then copy main.tex into your main folder and make a symbolic link to the `.gitignore` file.
> git commit -m"add config submodule"
> cp config/main.tex .
> cp config/.gitignore .
> cp config/main.tex config/.gitignore .
Edit 'main.tex', and input your tex files by writing `\include{my_file.tex}.
......@@ -44,11 +42,22 @@ This would make a heading called **Rincewind** in bold with a male symbol, and p
For a complete list of all the creatures and characters which can be used, see the 'monsters.tex' file.
For more details on the syntax, have a look at examples in *Adventures in Fenestra*, or read the git's wiki.
# Docs
You can create the documentation with
> make docs
Test your changes before committing with
> make test
# TeXnical Details
This thing's handled as a subtree in the other documments, so changing it will change all BIND books.
This thing's handled as a submodule in the other documments, so changing it will change all BIND books.
Any changes to the master branch should be tested in the `core` and `aif` projects first.
Personally, I keep it in a directory by the others. This allows you to do:
And when pulling, remember to do:
> git subtree -P config pull ../config master
> git pull --recurse-submodules
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment