Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
config
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Malin Freeborn
config
Commits
b29ea4b1
Unverified
Commit
b29ea4b1
authored
2 years ago
by
Malin Freeborn
Browse files
Options
Downloads
Patches
Plain Diff
update readme
parent
442039cb
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+18
-9
18 additions, 9 deletions
README.md
with
18 additions
and
9 deletions
README.md
+
18
−
9
View file @
b29ea4b1
...
...
@@ -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 sub
tre
e add
-P config git@
gitlab.com
:
bindrpg/config
.git master
> git sub
modul
e add
https://
gitlab.com
/
bindrpg/config
config
Then copy main.tex into your main folder and make a symbolic link to the
`.gitignore`
fi
le
.
> git commit -m"add config submodu
le
"
> 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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment