mirror of
https://github.com/org-roam/org-roam
synced 2025-08-01 12:17:21 -05:00
(release): v1.0.0 (#341)
This commit is contained in:
17
README.md
17
README.md
@ -1,6 +1,7 @@
|
||||
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
[](https://org-roam.readthedocs.io/en/latest/?badge=latest)
|
||||
[](https://img.shields.io/github/v/release/jethrokuan/org-roam)
|
||||
[](https://melpa.org/#/org-roam)
|
||||
|
||||
## Synopsis
|
||||
|
||||
@ -22,6 +23,7 @@ Important links:
|
||||
|
||||
- **[Documentation][docs]**
|
||||
- **[Org-roam Slack][slack]**
|
||||
|
||||
## A Preview
|
||||
|
||||
Here's a screenshot of `org-roam`. The `org-roam` buffer shows
|
||||
@ -34,13 +36,18 @@ structure, and can be used to navigate to the respective files.
|
||||
|
||||
## Installation
|
||||
|
||||
The recommended method is using use-package and straight, or a similar package manager.
|
||||
You can install `org-roam` using `package.el`:
|
||||
|
||||
```
|
||||
M-x package-install RET org-roam RET
|
||||
```
|
||||
|
||||
Here's a sample configuration with using `use-package`:
|
||||
|
||||
```emacs-lisp
|
||||
(use-package org-roam
|
||||
:hook
|
||||
(after-init . org-roam-mode)
|
||||
:straight (:host github :repo "jethrokuan/org-roam")
|
||||
:custom
|
||||
(org-roam-directory "/path/to/org-files/")
|
||||
:bind (:map org-roam-mode-map
|
||||
@ -51,9 +58,9 @@ The recommended method is using use-package and straight, or a similar package m
|
||||
(("C-c n i" . org-roam-insert))))
|
||||
```
|
||||
|
||||
For more detailed installation instructions (including instructions for
|
||||
Spacemacs users), please see [the installation
|
||||
documentation](https://org-roam.readthedocs.io/en/develop/installation/).
|
||||
For more detailed installation and configuration instructions (including for
|
||||
Doom and Spacemacs users), please see [the
|
||||
documentation](https://org-roam.readthedocs.io/en/master/installation/).
|
||||
|
||||
## Knowledge Bases using Org-roam
|
||||
|
||||
|
Reference in New Issue
Block a user