diff --git a/README.md b/README.md index cba75bf..ef41bdb 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Here's a sample configuration with `use-package`: :hook (after-init . org-roam-mode) :custom - (org-roam-directory "/path/to/org-files/") + (org-roam-directory (file-truename "/path/to/org-files/")) :bind (:map org-roam-mode-map (("C-c n l" . org-roam) ("C-c n f" . org-roam-find-file) @@ -56,6 +56,9 @@ Here's a sample configuration with `use-package`: (("C-c n i" . org-roam-insert)))) ``` +The `file-truename` function is only necessary when you use symbolic links +inside `org-roam-directory`: Org-roam does not resolve symbolic links. + Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for graph-related functionality. It is recommended to install PCRE-enabled ripgrep for better performance and extended functionality. diff --git a/doc/org-roam.org b/doc/org-roam.org index 4dc958a..f7a23a6 100644 --- a/doc/org-roam.org +++ b/doc/org-roam.org @@ -361,9 +361,12 @@ For this tutorial, create an empty directory, and set ~org-roam-directory~: #+BEGIN_SRC emacs-lisp (make-directory "~/org-roam") -(setq org-roam-directory "~/org-roam") +(setq org-roam-directory (file-truename "~/org-roam")) #+END_SRC +The ~file-truename~ function is only necessary when you use symbolic links +inside ~org-roam-directory~: Org-roam does not resolve symbolic links. + Next, we setup Org-roam to run functions on file changes to maintain cache consistency. This is achieved by running ~M-x org-roam-setup~. To ensure that Org-roam is available on startup, place this in your Emacs configuration: