summaryrefslogtreecommitdiffstatshomepage
path: root/readme.org
diff options
context:
space:
mode:
authorGravatar Nicolas Petton2021-03-12 13:50:43 +0100
committerGravatar Nicolas Petton2021-03-12 13:50:43 +0100
commit13e364edef1e1e6f98d89343486d47974d819bb0 (patch)
treef9c5808e6714d1794131c0db062836fb95c16b0b /readme.org
parent68e9270ebe205296ab9868e1f8722a1b572404c3 (diff)
downloadnroam-13e364edef1e1e6f98d89343486d47974d819bb0.tar.gz
nroam-13e364edef1e1e6f98d89343486d47974d819bb0.zip
Fix #9
Document installation with straight.el.
Diffstat (limited to 'readme.org')
-rw-r--r--readme.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.org b/readme.org
index 81a283b..48742c7 100644
--- a/readme.org
+++ b/readme.org
@@ -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: