Skip to content
Snippets Groups Projects
README.md 741 B
Newer Older
  • Learn to ignore specific revisions
  • These config files make the BIND RPG books look and act the way they do.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    # Usage
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    To make a book, start a git, then do:
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    > git submodule add https://gitlab.com/bindrpg/config config
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    > git commit -m"add config submodule"
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    > cp config/main.tex config/.gitignore .
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    Edit 'main.tex', and input your tex files by writing `\include{my_file.tex}`.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    # Docs
    
    You can create the documentation with
    
    > make docs
    
    Test your changes before committing with
    
    > make test
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    # TeXnical Details
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    This thing's handled as a submodule in the other documents, so changing it will change all BIND books.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    Any changes to the master branch should be tested in the `core` and `aif` projects first.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    And when pulling, remember to do:
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    > git pull --recurse-submodules
    
    Malin Freeborn's avatar
    Malin Freeborn committed