diff --git a/README.org b/README.org index 6055d20..332c8af 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,18 @@ -#+TITLE: Readme +#+TITLE: README +* About A major mode for viewing Tiddlywiki tiddlers. Right now it's just some colors and formatting. +Check out Tiddlywiki, it's great! https://tiddlywiki.com/ + Also: I'm very new to emacs and this is my first experiment with elisp. I'm sure my code is wacky! --Chris -chrisbeckstrom.com +* Requirements +- Emacs +- Olivetti - https://opensourcelibs.com/lib/olivetti + +* Here's how I'm using it: +- The file =tiddler-mode.el= is at =~/tiddler-mode.el/tiddler-mode.el= +- It's symbolically linked to inside my =~/.emacs.d/= directory (=cd ~/.emacs.d/ && ln -s ~/tiddler-mode.el/tiddler-mode.el .=) +- in my =~/.doom.d/config.el= I do this: =(load "~/.emacs.d/tiddler-mode.el")= +- When opening a file with a =.tid= extension, this mode should be enabled and your tiddlers should look a little prettier :-)