commit 63406d1caddb83fd13479c984ab4a725ed5c17b7
parent 6f6d3148ffa8e846c3fa58bf7bc25593073e4e74
Author: Jake Bauer <jbauer@paritybit.ca>
Date: Thu, 19 Dec 2019 13:01:43 -0500
Update readme
Diffstat:
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -5,8 +5,8 @@ and build script for the [paritybit.ca](https://www.paritybit.ca) website.
The build script `createpages.sh` was written to serve the needs of building my
webpages and was not coded to be a tool for the general public. Therefore, a lot
-of the solutions depend on structuring a page in a specific way so that I didn't
-need to bother making the solution work in general use cases.
+of the solutions depend on structuring a page in a specific way and the whole
+script looks quite hacky. It makes me feel warm and fuzzy.
To build a page that is properly compiled by the script, there are 5 essential
things:
@@ -26,12 +26,13 @@ things:
subsub:gcc; sub:Environment; Further Reading"`.
5. The content of 2-4 must be enclosed by double-quote `"` characters and
preceded by markdown "comment markers": `[//]:`. 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 (markdown comment markers may be left).
+ needed, the line must still exist but, other than the markdown comment
+ marker, the line must be blank. There shouldn't even be double quote
+ characters on the line.
See the files in the `pages/` directory for examples.
-The code for this website (Javascript and the code in this repository) is
+The code for this website (the JavaScript and the code in this repository) is
licensed under the GNU GPLv3.0-or-later. The content of the web pages (HTML+CSS)
is licensed under the Creative Commons Attribution-ShareAlike 4.0 International
License.
