diff --git a/README.org b/README.org index ba09dc0..fe00de0 100644 --- a/README.org +++ b/README.org @@ -1,19 +1,33 @@ -* Org-roam (⚠ Early in Development) +* Org-roam -Rudimentary [[https://roamresearch.com/][Roam]] replica in Org-mode. This brings the benefits of the -graph-like note-taking tool to Org-mode, without custom Org syntax. +** About -Here's a screenshot of ~org-roam~. The ~org-roam~ buffer shows -backlinks for the active org buffer in the left window, as well as the -surrounding content in the backlink file. +Org-roam is a rudimentary [[https://roamresearch.com/][Roam]] replica in Org-mode. This project intends to adaptively implement the core features of Roam in org-mode and eventually introduce newer features suitable for the Emacs ecosystem. It offers a *non-hierarchical* notetaking approach which is *effortless* yet powerful. Notetaking becomes fluent and easy when you don't have to worry about /where/ a particular note should go --- you just start writing from anywhere about anything. -The backlink database is built asynchronously in the background, so -there will be no significant slowdown. +To know more about Roam, these following links are recommended. + +- [[reddit.com/r/RoamResearch/comments/eho7de/building_a_second_brain_in_roamand_why_you_might][Building a second brain in Roam]] +- [[https://www.nateliason.com/blog/roam][Roam: Why I Love It and How I Use It]] + +The best way to understand the usefulness of this approach is to actually try it. + + +** Project Status + +As of February 2020, it is in a very early stage of development. + + +** Screenshot + +Here's a screenshot of ~org-roam~. The ~org-roam~ buffer shows backlinks for the active org buffer in the left window, as well as the surrounding content in the backlink file. +The backlink database is built asynchronously in the background, so there will be no significant slowdown. #+DOWNLOADED: screenshot @ 2020-02-03 17:10:40 [[file:images/readme/screenshot2020-02-03_17-10-40_.png]] -** Usage +** Installation + +You need to have [[https://jblevins.org/projects/deft/][deft]] installed. #+begin_src emacs-lisp (use-package deft @@ -35,3 +49,29 @@ there will be no significant slowdown. ("C-c n t" . org-roam-today) ("C-c n i" . org-roam-insert)) #+end_src + +*Failback installation*: + +Clone the git repo locally and in your emacs init.el put something like + +#+begin_src emacs-lisp + + (add-to-list 'load-path "~/Downloads/org-roam") + (require 'org-roam) +#+end_src + + +** Quickstart + +Toy scenario: Suppose you want to keep track of all the cool-facts you come across, but it is really effortsome to everytime find the exact file to note an individual cool-fact. + +1. Open a deft file and start writing about anything. Now in any sentence you can call the function ~org-roam-insert~ and choose the filename ~cool-facts~ and then keep on writing whatever you want. + +2. Later when you open ~cool-facts.org~ and call ~org-roam~ you will see all the places you have referenced this file. So all the cool-facts you have writen anywhere in your deft database are easily accessible from here. + +** Contributing + +Pull requests with improvements are very welcome. For feature requests create Github issues. + + +