From 13e364edef1e1e6f98d89343486d47974d819bb0 Mon Sep 17 00:00:00 2001 From: Nicolas Petton Date: Fri, 12 Mar 2021 13:50:43 +0100 Subject: Fix #9 Document installation with straight.el. --- readme.org | 15 +++++++++++++++ 1 file changed, 15 insertions(+) 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: -- cgit v1.2.3-54-g00ecf