aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSpencer Williams <spnw@plexwave.org>2025-04-07 17:25:45 -0400
committerSpencer Williams <spnw@plexwave.org>2025-04-07 17:25:45 -0400
commite83dbc991b70c670502f33151ddf70bf4cf6ad72 (patch)
tree7d1d037834993d5c1d9559bfb349edd291aa2afe
parent41e4bce247ad81945aa92b6fd66b1a6d107988aa (diff)
Use Org for README (sorry cgit)
-rw-r--r--README.md36
-rw-r--r--README.org31
2 files changed, 31 insertions, 36 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 3d9c376..0000000
--- a/README.md
+++ /dev/null
@@ -1,36 +0,0 @@
-## A personal wiki toolkit for Emacs
-
-[Seam](https://wiki.plexwave.org/seam) leverages the power of [Org
-mode](https://orgmode.org/) to make creating, linking, and exporting
-your notes easier. It is geared particularly towards creating a
-personal wiki — a place where you can share some portion of your notes
-with the world. It takes inspiration from the likes of
-[Obsidian](https://obsidian.md/) and
-[MediaWiki](https://www.mediawiki.org/wiki/MediaWiki).
-
-Three of Seam's key design tenets are:
-
-- Org files and their resultant HTML files should always be kept in
- sync.
-- It should be easy to create multiple sites using different subsets
- of the same note collection.
-- Notes should not be unnecessarily clouded with metadata.
-
-Be aware that Seam is a fully self-contained package, and is not
-likely to be compatible with things like
-[Org-roam](https://www.orgroam.com/) due to its vastly different
-approach.
-
-### Getting started
-
-The easiest way to begin is to follow the brief
-[tutorial](https://wiki.plexwave.org/seam-tutorial).
-
-### Documentation
-
-Seam's manual is still being written. In the meantime, the [project
-page](https://wiki.plexwave.org/seam) contains some more tidbits you
-might find useful.
-
-I have endeavored to make Seam fairly self-documenting, so check the
-docstrings and the Seam customization group when in any doubt.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..f0b9069
--- /dev/null
+++ b/README.org
@@ -0,0 +1,31 @@
+** A personal wiki toolkit for Emacs
+
+[[https://wiki.plexwave.org/seam][Seam]] leverages the power of [[https://orgmode.org/][Org mode]] to make creating, linking, and
+exporting your notes easier. It is geared particularly towards
+creating a personal wiki — a place where you can share some portion of
+your notes with the world. It takes inspiration from the likes of
+[[https://obsidian.md/][Obsidian]] and [[https://www.mediawiki.org/wiki/MediaWiki][MediaWiki]].
+
+Three of Seam's key design tenets are:
+
+- Org files and their resultant HTML files should always be kept in
+ sync.
+- It should be easy to create multiple sites using different subsets
+ of the same note collection.
+- Notes should not be unnecessarily clouded with metadata.
+
+Be aware that Seam is a fully self-contained package, and is not
+likely to be compatible with things like [[https://www.orgroam.com/][Org-roam]] due to its vastly
+different approach.
+
+*** Getting started
+
+The easiest way to begin is to follow the brief [[https://wiki.plexwave.org/seam-tutorial][tutorial]].
+
+*** Documentation
+
+Seam's manual is still being written. In the meantime, the [[https://wiki.plexwave.org/seam][project
+page]] contains some more tidbits you might find useful.
+
+I have endeavored to make Seam fairly self-documenting, so check the
+docstrings and the Seam customization group when in any doubt.