diff options
| author | Grant Shangreaux <grant@unabridgedsoftware.com> | 2022-11-19 19:37:20 -0600 |
|---|---|---|
| committer | Grant Shoshin Shangreaux <shoshin@cicadas.surf> | 2022-11-19 19:58:46 -0600 |
| commit | 999c951b43dbd40ec42dced7fbeb93cd43ff54a3 (patch) | |
| tree | 4618036ddf934381fff52b9ddb3d322f5573b556 | |
| parent | 0134e486e26b10bbaa9512725e8aa5fc8e4040cd (diff) | |
Clean: test annotations Add: get started section & annotation
| -rw-r--r-- | annotations | 4 | ||||
| -rw-r--r-- | coorgi-client.org | 38 |
2 files changed, 33 insertions, 9 deletions
diff --git a/annotations b/annotations index be098d8..f00a565 100644 --- a/annotations +++ b/annotations @@ -1 +1,3 @@ -(("~/projects/coorgi-client/coorgi-client.org" ((383 452 "So just trying this out -colin" "If you evaluate the following block, it will effecively \"eval-buffer\"") (1232 1235 "find a simple example of modifying the org-data structure -g" "***") (1488 1490 "these were some of the sync features we chatted about -g" "**") (1710 1711 "trying again -g" "*")) "17fa2b5715c813dadcb07ca0b6ec4ec3"))
\ No newline at end of file +(("~/projects/coorgi-client/coorgi-client.org" ((109 325 "please refine this block, i know you've got some good language for it out there -g" "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.")) "4e3141987ad14628245a6cc8b771e9f8")) 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 |