about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorahriman <ahriman@falte.red>2019-09-02 17:42:06 -0400
committerahriman <ahriman@falte.red>2019-09-02 17:42:06 -0400
commit0381bce35845cb387fcd7ce124da60b9c45c611a (patch)
treea28be6c57f92aa6b183f5ccc453cddfecea3c833 /README.md
downloadwiki-0381bce35845cb387fcd7ce124da60b9c45c611a.tar.gz
tildewiki
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80f970e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# wiki.tilde.institute
+
+This repository holds the wiki data for tilde.institute
+
+To contribute:
+* Fork the repository
+* Create a branch with an appropriate name:
+  * `git checkout -b mycoolpage`
+* Add your page in the `pages/` directory
+* Submit a PR
+
+Don't forget to wrap lines at approximately 75 columns. If
+you need to, use `fmt -w 75`. For example:
+
+```
+$ fmt -w 75 mypage.md | tee mypage.md
+```
+Then afterwards, check the page to fix anything that got
+clobbered.
+
+## Software
+
+The wiki engine being used is [TildeWiki](https://github.com/gbmor/tildewiki), developed by ahriman