aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHolden Rohrer <hr@hrhr.dev>2020-05-22 00:50:26 -0400
committerHolden Rohrer <hr@hrhr.dev>2020-05-22 00:50:26 -0400
commit064af7268d29bbbd66b47c379a5dcf77a13aa2ee (patch)
tree01708aedc1d2fca00945d6459ecd3777b3d82c3a /README
parentada49a8aca89eeb23bee69bebea468681657333c (diff)
added filetype description in README
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 12 insertions, 1 deletions
diff --git a/README b/README
index 4bb969b..e75fade 100644
--- a/README
+++ b/README
@@ -1,4 +1,15 @@
# tmplt
A hierarchical filetype based on descriptions and a directed acyclic
-graph. `template` is an example of this filetype
+graph.
+
+# filetype description
+`template` is an example of this filetype.
+
+For every line,
+- colon, start new topic
+- hyphen and optional spaces, treat as link
+- nothing (i.e. trailing spaces and a nl), skip.
+- dot or other, take literally (as a desc)
+
+Always trim ending spaces