summaryrefslogtreecommitdiff
path: root/README.org
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.org
Initial commitv0.1.0
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..f5ea4ce
--- /dev/null
+++ b/README.org
@@ -0,0 +1,10 @@
+[[https://wiki.plexwave.org/seam][Seam]] is a personal wiki system based on [[https://orgmode.org/][Org mode]].
+
+* 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 [[https://wiki.plexwave.org/seam][project page]] and the
+[[https://wiki.plexwave.org/seam-tutorial][tutorial]]. I have endeavored to make Seam fairly self-documenting, so
+also see the docstrings and the Seam customization group.