awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): link to discourse in README (#577)

Browse Source 
Also, add information about Graphviz on the README.

Co-authored-by: Jethro Kuan <jethrokuan95@gmail.com>
This commit is contained in:
Günter Zöchbauer
2020-05-09 13:54:05 +02:00
committed by GitHub
parent dee540b62f
commit d3206b797a
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -27,6 +27,7 @@ As of February 2020, it is in a very early stage of development.
Important links: Important links:
- **[Documentation][docs]** - **[Documentation][docs]**
- **[Discourse][discourse]**
- **[Org-roam Slack][slack]** - **[Org-roam Slack][slack]**
## A Preview ## A Preview
@ -64,6 +65,12 @@ Here's a sample configuration with using `use-package`:
(("C-c n i" . org-roam-insert)))) (("C-c n i" . org-roam-insert))))
``` ```
`org-roam-graph` by default expects to find the `dot` executable
from the `graphviz` package in the `exec-path`.
Ensure `graphviz` is installed and found if you want to use this
feature or customize your configuration for `org-roam-graph` to use a
different tool.
For more detailed installation and configuration instructions (including for For more detailed installation and configuration instructions (including for
Doom and Spacemacs users), please see [the Doom and Spacemacs users), please see [the
documentation](https://org-roam.readthedocs.io/en/master/installation/). documentation](https://org-roam.readthedocs.io/en/master/installation/).
@ -92,4 +99,5 @@ General Public License, Version 3
[org]: https://orgmode.org/ [org]: https://orgmode.org/
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg [badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
[docs]: https://org-roam.readthedocs.io/ [docs]: https://org-roam.readthedocs.io/
[discourse]: https://org-roam.discourse.group/
[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg [slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg