diff --git a/manual.html b/manual.html index 07e5d81..87d2e35 100644 --- a/manual.html +++ b/manual.html @@ -135,7 +135,13 @@ Installation
+ +Installation Troubleshooting + +
@@ -452,7 +458,7 @@ development repository.
M-x package-install RET org-roam RET-
Now see Post-Installation Tasks. -
@@ -530,7 +534,7 @@ using Apt:
-Next: Post-Installation Tasks, Previous: Installing from Apt, Up: Installation [Index]
+Next: Installation Troubleshooting, Previous: Installing from Apt, Up: Installation [Index]You can install this manually as well, or get the latest version from MELPA. You @@ -624,28 +628,68 @@ file:
Previous: Installing from Source, Up: Installation [Index]
Org-roam requires sqlite3
to be locatable by Emacs (i.e. on exec-path
).
-Please ensure that sqlite3
is installed appropriately on your operating
-system. You can verify that this is the case by executing 2:
+
• C Compiler | + |
Org-roam relies on an Emacs package called emacsql
and emacsql-sqlite
to
+work with the sqlite
database. Both of them should be installed automatically
+in your Emacs environment as a prerequisite for Org-roam when you install it.
(executable-find "sqlite3") ++
emacsql-sqlite
requires a C compiler (e.g.gcc
orclang
) to be present in +your computer. How to install a C compiler depends on the OS that you use. +
There are various ways to install one, depending on how you have installed +Emacs. If you use Emacs within a Cygwin or MinGW environment, then you should +install a compiler using their respective package manager. +
+If you have installed your Emacs from the GNU Emacs website, then the easiest way +is to use MSYS2 as at the time of this writing: +
+pacman -S gcc
If you have sqlite3
installed, and executable-find
still reports nil
, then
-the path to the executable is not a member of the Emacs variable exec-path
.
-Rectify this by manually adding the path within your Emacs configuration:
+
Note that you do not need to manually set the PATH for MSYS2; the +
installer automatically takes care of it for you.
-(add-to-list 'exec-path "path/to/sqlite3") -
M-x org-roam-setup
+This will automatically start compiling emacsql-sqlite
; you should see a
+
message in minibuffer. It may take a while until compilation completes. Once
+complete, you should see a new file emacsql-sqlite.exe
created in a subfolder
+named sqlite
under emacsql-sqlite
installation folder. It’s typically in
+your Emacs configuration folder like this:
+/.config/emacs/elpa/emacsql-sqlite-20190727.1710/sqlite
+
@@ -2444,10 +2488,6 @@ Previous: Function Index,
To understand more about Roam, a collection of links are available in Note-taking Workflows.
-Two easy ways to evaluate elisp: 1) Place the cursor after the closing -paren and run ‘M-x eval-last-sexp RET’ or 2) Press ‘C-c C-c’ with your cursor in -an Org file code block (like ‘#+BEGIN_SRC emacs-lisp’).