diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 34 insertions, 13 deletions
@@ -1,13 +1,34 @@ -[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. +## A personal wiki toolkit for Emacs + +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 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. |