From f7565250a0aa5900b09f6bcdb761fd86e34b8c1d Mon Sep 17 00:00:00 2001
From: Malin Freeborn <malinfreeborn@tutamail.com>
Date: Tue, 2 Mar 2021 18:48:06 +0100
Subject: [PATCH] update config readme
---
README.md | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 1ef741d9..fc6b17ed 100644
--- a/README.md
+++ b/README.md
@@ -16,25 +16,30 @@ Edit 'main.tex', and input your tex files by writing `\include{my_file.tex}.
## Creatures
-You can include pseudo-randomo creatures in your adventure by summoning the names from monsters.tex. For example, to place a random elf in your game, just write `\elf`, and an elf will be magically summoned unto your adventure. You can give the character a title and name by writing '\npc{symbol}{name}'. For example:
+You can include pseudo-randomo creatures in your adventure by summoning the names from monsters.
+. For example, to place a random elf in your game, just write `\elf`, and an elf will be magically summoned unto your adventure.
+```
+\elf
```
-\npc{\M}{Rincewind}
+You can give the character a title and name by writing '\npc{symbol}{name}' as an optional argument.
+For example:
-\humanalchemist
+```
+\humanalchemist[\npc{\M}{Rincewind}]
```
This would make a heading called **Rincewind** in bold with a male symbol, and provide pseudo-random alchemist-appropriate stats underneath.
| Syntax | Symbol |
-|:---:|:----:|
-| \\M | Male |
-| \\F | Female |
-| \\T | Team |
-| \\D | Undead |
-| \\N | Nura |
+|:------:|:------:|
+| \\M | Male |
+| \\F | Female |
+| \\T | Team |
+| \\D | Undead |
+| \\N | Nura |
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.
--
GitLab