awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-14 15:46:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ 176b2bf19d 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-09-26 05:56:43 +00:00
parent b741d8c597
commit 4e63382bb7
4 changed files with 207 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
manual/Installing-from-the-Git-Repository.html
View File

@@ -66,9 +66,78 @@ ul.no-bullet {list-style: none}
Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="n" rel="next">Post-Installation Tasks</a>, Previous: <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="p" rel="prev">Installing from Apt</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="TODO-Installing-from-the-Git-Repository"></a>
<h3 class="section">4.3 <strong>TODO</strong> Installing from the Git Repository</h3>
<a name="Installing-from-the-Git-Repository-1"></a>
<h3 class="section">4.3 Installing from the Git Repository</h3>
<p>You may install Org-roam directly from the repository on <a href="https://github.com/org-roam/org-roam">GitHub</a> if you like. This will give you access to the latest version hours or days before it appears on MELPA, and months (or more) before it is added to the Debian or Ubuntu repositories. This will also give you access to various developmental branches that may be available.
</p>
<p>Note, however, that development version, and especially any feature branches, may not always be in working order. You&rsquo;ll need to be prepared to do some debugging, or to manually roll-back to working versions, if you install from GitHub.
</p>
<p>Installing from GitHub requires that you clone the repository:
</p>
<div class="example">
<pre class="example">git clone https://github.com/org-roam/org-roam.git /path/to/org/roam
</pre></div>
<p>where <code>./path/to/org/roam</code> is the location you will store your copy of the code.
</p>
<p>Next, you need to add this location to your load path, and <code>require</code> the Org-roam library. Add the following code to your <code>.emacs</code>:
</p>
<div class="lisp">
<pre class="lisp">(add-to-list 'load-path &quot;/path/to/org/roam&quot;)
(require 'org-roam)
</pre></div>
<p>You now have Org-roam installed. However, you don&rsquo;t necessarily have the dependencies that it requires. These include:
</p>
<ul>
<li> dash
</li><li> f
</li><li> s
</li><li> org
</li><li> emacsql
</li><li> emacsql-sqlite3
</li></ul>
<p>You can install this manually as well, or get the latest version from MELPA. You may wish to use <a href="https://github.com/jwiegley/use-package">use-package</a>, <a href="https://github.com/raxod502/straight.el">straight.el</a>, or some other tool or tools to help manage this.
</p>
<p>If you would like to install the manual for access from Emacs&rsquo; built-in Info system, you&rsquo;ll need to compile the .texi source file, and install it in an appropriate location.
</p>
<p>To compile the .texi source file, from a terminal navigate to the <code>/doc</code> subdirectory of the Org-roam repository, and run the following:
</p>
<div class="example">
<pre class="example">make infodir=/path/to/my/info/files install-info
</pre></div>
<p>Where <code>/path/to/my/info/files</code> is the location where you keep info files. This target directory needs to be stored in the variable &lsquo;Info-default-directory-list&lsquo;. If you aren&rsquo;t using one of the default info locations, you can configure this with the following in your <code>.emacs</code> file:
</p>
<div class="lisp">
<pre class="lisp">(require 'info)
(add-to-list 'Info-default-directory-list
&quot;/path/to/my/info/files&quot;)
</pre></div>
<p>You can also use one of the default locations, such as:
</p>
<ul>
<li> <em>usr/local/share/info</em>
</li><li> <em>usr/share/info</em>
</li><li> <em>usr/local/share/info</em>
</li></ul>
<p>If you do this, you&rsquo;ll need to make sure you have write-access to that location, or run the above <code>make</code> command as root.
</p>
<p>Now that the info file is ready, you need to add it to the corresponding <code>dir</code> file:
</p>
<div class="example">
<pre class="example">install-info /path/to/my/info/files/org-roam.info /path/to/my/info/files/dir
</pre></div>
<hr>
<div class="header">
<p>
Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="n" rel="next">Post-Installation Tasks</a>, Previous: <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="p" rel="prev">Installing from Apt</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>