commit 6452c0dd2b983fb13ab34a51bb5785c9ed956071
parent 4ddf4d59c7ce094c50002146e4e22662f9b0f1f1
Author: Jake Bauer <jbauer@paritybit.ca>
Date: Thu, 12 Sep 2019 10:58:42 -0400
Add example to point 4 of readme
Diffstat:
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -21,7 +21,9 @@ things:
4. The seventh line of the file must be a list of the
sections/subsections/subsubsections which will become the content of the
table of contents (the name of a section and the name of the header it is
- pointing to _must_ be identical).
+ pointing to _must_ be identical). This is a semicolon `;`separated list of
+ header names like so: `"Introduction; Building; sub:Compiling; subsub: clang;
+ subsub:gcc; sub:Environment; Further Reading"`
5. The content of 2-4 must be enclosed by double-quote `"` characters. If any of
1-4 are not needed, the line must still exist but there must be no content on
the line, not even the double-quote characters.
