summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSpencer Williams <spnw@plexwave.org>2025-03-15 10:34:16 -0400
committerSpencer Williams <spnw@plexwave.org>2025-03-15 10:34:16 -0400
commit3cebea64952e4b498aee591665f2b6ed50da5498 (patch)
tree48951d8b2d350ede30a7f93ba97e7cd348caddf1 /README.md
Initial commitv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a3f75e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+[Seam](https://wiki.plexwave.org/seam) is a personal wiki system based
+on [Org mode](https://orgmode.org/).
+
+# Installation
+Clone this repo and add it to your load path. As long as your system
+has `find` and `grep` installed, no further setup should be required.
+
+# Documentation
+For now, the best way to learn about Seam is the [project
+page](https://wiki.plexwave.org/seam) and the
+[tutorial](https://wiki.plexwave.org/seam-tutorial). I have
+endeavored to make Seam fairly self-documenting, so also see the
+docstrings and the Seam customization group.