summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
authorLinnnus <[email protected]>2024-02-01 22:59:38 +0100
committerLinnnus <[email protected]>2024-02-04 09:58:06 +0100
commitd38f82f6462af4e5aad6a2c776f5c00ce5b13c87 (patch)
tree01a222792dfb10473ae4370b4fc90f3a48e1a499 /readme.txt
feat: initial commit
Here is a small overview of the state of the project at this first commit. I have basic Git Repo -> HTML working, and a plan for how setting up an actual server would work (mainly, NGINX + a git hook to rebuild). The main thing I'm working on right now is parsing WikiCreole, though I am starting to wonder if this is the right langauge. WikiCreole is pretty irregular and has a lot of edge cases (e.g. around emphasis).
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..c4e1e00
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,16 @@
+My Simple wiki system
+=====================
+
+This project is an attempt to make the simplest wiki possible. It uses a proper
+version control system to avoid the inner platform effect [1] and it does
+simple, stateless rendering of a basic markup language [3].
+
+The hope is that this simplicity leads to composability and extensibility. In a
+way, these files represent my effort to understand and fully appreaciate The
+Unix Philosophy™ [2].
+
+[1]: https://thedailywtf.com/articles/The_Enterprise_Rules_Engine
+[2]: http://www.catb.org/~esr/writings/taoup/html/ch01s06.html
+[3]: http://www.wikicreole.org/
+
+ vi: ft=plaintext tw=80