summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Steinbeiss <simon.steinbeiss@elfenbeinturm.at>2020-05-13 00:37:15 +0200
committerSimon Steinbeiss <simon.steinbeiss@elfenbeinturm.at>2020-05-13 00:37:15 +0200
commit318d8c9ba011c2301bf9c66494fb7851298c5ac4 (patch)
treed7511781633d56f315f157bb49051dde8f2fa6a6
parent54191aaa84fa812525ca54e177fe49e73d36eae4 (diff)
downloadgarcon-318d8c9ba011c2301bf9c66494fb7851298c5ac4.tar.gz
README: Use table for debug arguments
-rw-r--r--README.md15
1 files changed, 5 insertions, 10 deletions
diff --git a/README.md b/README.md
index 20d0933..f2de511 100644
--- a/README.md
+++ b/README.md
@@ -30,16 +30,11 @@ garcon currently supports three different levels of debugging support,
which can be setup using the configure flag `--enable-debug` (check the output
of `configure --help`):
- `yes` This is the default for Git snapshot builds. It adds all kinds
- of checks to the code, and is therefore likely to run slower.
- Use this for development of garcon and locating bugs in
- garcon.
-
- `minimum` This is the default for release builds. This is the recommended
- behaviour.
-
- `no` Disables all sanity checks. Don't use this unless you know
- exactly what you do.
+| Argument | Description |
+| ------- | ----------- |
+| `yes` | This is the default for Git snapshot builds. It adds all kinds of checks to the code, and is therefore likely to run slower. Use this for development of garcon and locating bugs in garcon. |
+| `minimum` | This is the default for release builds. **This is the recommended behaviour.** |
+| `no` | Disables all sanity checks. Don't use this unless you know exactly what you do. |
## How to report bugs?