diff options
Diffstat (limited to 'coorgi-client.org')
| -rw-r--r-- | coorgi-client.org | 38 |
1 files changed, 30 insertions, 8 deletions
diff --git a/coorgi-client.org b/coorgi-client.org index 6860ca0..17383de 100644 --- a/coorgi-client.org +++ b/coorgi-client.org @@ -1,17 +1,39 @@ #+PROPERTY: header-args:emacs-lisp :lexical t -#+name: test-trivial-example-cursor-in-body -#+begin_src emacs-lisp :var org-doc=trivial-example() - (let ((subject (with-temp-buffer (insert org-doc) (org-element-parse-buffer)))) - (print subject) - (print (org-element-interpret-data subject))) -#+end_src +* Coorgi Client - A collaborative org document sync client. +Coorgi stands for "cooperative org interchange", and intends to enable +multiple users to sync org documents between one another. Possible uses +include issue trackers, shared agendas, and near real-time collaboration. + +** Start hacking on this literate program + +Assuming you're using Emacs, this project is written as literate code. +This document /is/ the program, written for humans first. Some things +to ensure your environment is ready to go: + +- enable emacs lisp and org as org-babel languages + + #+begin_src emacs-lisp + (org-babel-do-load-languages + 'org-babel-load-languages + '((emacs-lisp . t) + (org . t))) + #+end_src + +- install the ~annotate~ package (optional) + + #+begin_src emacs-lisp + (package-install 'annotate) + #+end_src + + We're experimenting with using ~annotate-mode~ to comment on the document. + The ~.dir-locals~ file here will set the annotate database file to the + ~annotations~ file in this repository. -* Coorgi Client - A collaborative org document sync client. ** Overview -If you evaluate the following block, it will effecively "eval-buffer" +If you evaluate the following block, it will effectively "eval-buffer" on the whole shebang. #+begin_src emacs-lisp :tangle yes :noweb no-export :results silent |