readme

README.md

@@ -8,7 +8,7 @@ It consists of two parts:
 
 1. Elisp for functionality within emacs. Most of it is integrated directly with the `project` interface, and consists the ability to find a file from a filename.
 
-2. Bash scripts for the commandline interface. I prefer a CLI for file creation and management rather than more emacs functions, because chaining shell commands is easy and I think of the commandline as the point of reference for all filesystem management.
+2. Shell scripts for the commandline interface. I prefer a CLI for file creation and management rather than more emacs functions, because chaining shell commands is easy and I think of the commandline as the point of reference for all filesystem management.
 
 Conceptually, `um` is somewhat like org-roam, except without any database dependency. (And it assumes Markdown rather than org, which I don't care for.)
 
@@ -22,7 +22,22 @@ The "database" depends on a few simple ideas:
 
 4. Using the built-in emacs `project` package to organize compositions built from these source files.
 
-## config
+## installation
+
+Clone it:
+
+```
+git clone https://git.bth.moi/bth/um.git ~/um
+```
+
+Symlink the `um` CLI somewhere in your `PATH`:
+
+```
+cd ~/um
+ln -s ~/um/shell/um /usr/local/bin/um
+```
+
+## emacs config
 
 My config looks like this:
 
@@ -35,6 +50,6 @@ My config looks like this:
 
   (advice-add 'embark-target-file-at-point :around 'uldb-file-at-point-advice)
 
-  :load-path "~/dev/um/elisp"
+  :load-path "~/um/elisp"
 )
 ```