(docs): link to discourse in README (#577)
Also, add information about Graphviz on the README. Co-authored-by: Jethro Kuan <jethrokuan95@gmail.com>
This commit is contained in:
parent
dee540b62f
commit
d3206b797a
1 changed files with 8 additions and 0 deletions
|
@ -27,6 +27,7 @@ As of February 2020, it is in a very early stage of development.
|
|||
Important links:
|
||||
|
||||
- **[Documentation][docs]**
|
||||
- **[Discourse][discourse]**
|
||||
- **[Org-roam Slack][slack]**
|
||||
|
||||
## A Preview
|
||||
|
@ -64,6 +65,12 @@ Here's a sample configuration with using `use-package`:
|
|||
(("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
|
||||
Doom and Spacemacs users), please see [the
|
||||
documentation](https://org-roam.readthedocs.io/en/master/installation/).
|
||||
|
@ -92,4 +99,5 @@ General Public License, Version 3
|
|||
[org]: https://orgmode.org/
|
||||
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
|
||||
[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
|
||||
|
|
Loading…
Reference in a new issue