diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -10,14 +10,18 @@ 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. +*Note:* Requires Emacs 29 or greater, with Org 9.6 or greater. + *** Getting started The easiest way to begin is to follow the brief [[https://wiki.plexwave.org/seam-tutorial][tutorial]]. @@ -29,3 +33,21 @@ 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. + +*** Known issues + +- =find-file= does not create notes properly. You should use + =seam-find-note= instead. + +- Commented-out links are not ignored, e.g. for determining backlinks. + +- Tags in note title headlines are not ignored; they are treated as + part of the title. + +- =seam:= links /must/ have a description. Bare links are not + supported. + +*** Upgrading + +As a new project, Seam is very much in flux. Whenever you upgrade it, +please see the [[file:CHANGELOG.org][changelog]] for breaking changes, new features, etc. |