diff options
author | Nicolas Petton | 2021-03-12 13:50:43 +0100 |
---|---|---|
committer | Nicolas Petton | 2021-03-12 13:50:43 +0100 |
commit | 13e364edef1e1e6f98d89343486d47974d819bb0 (patch) | |
tree | f9c5808e6714d1794131c0db062836fb95c16b0b | |
parent | 68e9270ebe205296ab9868e1f8722a1b572404c3 (diff) | |
download | nroam-13e364edef1e1e6f98d89343486d47974d819bb0.tar.gz nroam-13e364edef1e1e6f98d89343486d47974d819bb0.zip |
Fix #9
Document installation with straight.el.
-rw-r--r-- | readme.org | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -32,6 +32,21 @@ become more powerful. You could for instance make a sparse tree—see =org-sparse-tree= — to filter the contents of a note and its backlinks at the same time. +* Installation + +nroam is not yet available in [[https://melpa.org][MELPA]]. Until it is, you can install the Elisp files by hand in your =.emacs.d= or if you use =straight.el= add the following to you init file. + +#+begin_src elisp +(use-package nroam + :straight '(nroam :host github + :branch "master" + :repo "NicolasPetton/nroam") + :after org-roam + :config + (add-hook 'org-mode-hook #'nroam-setup-maybe)) +#+end_src + + * Setup & usage To setup nroam for all =org-mode= buffer, evaluate the following: |