summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2014-04-01 00:21:49 -0400
committerKyle Meyer <kyle@kyleam.com>2014-04-01 11:49:02 -0400
commit62a8e219bcde92cf486aed55e64beaadd4a6c8b2 (patch)
treecb4903577c81aa10c27ff1abcc6402ffa4f4b45f
parent9fcca8568e994bf758fc0a7d2092618b7f525d5c (diff)
downloadbog-62a8e219bcde92cf486aed55e64beaadd4a6c8b2.tar.gz
Add installation instructions
-rw-r--r--README.md8
-rw-r--r--bog-readme.org10
2 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index e17da3f..9852c28 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,14 @@ Bog is a system for taking research notes in [Org mode](http://orgmode.org/). It
research-specific features, nearly all of which are focused on managing
and taking notes with Org, not on writing research articles with Org.
+# Installation
+
+Bog is available on [MELPA](http://melpa.milkbox.net/).
+
+To enable Bog in all Org buffers, add it to `org-mode-hook`.
+
+ (add-hook 'org-mode-hook 'bog-mode)
+
# Workflow
Many people use Org for taking research notes, and there are some really
diff --git a/bog-readme.org b/bog-readme.org
index 5a1b7f7..fb67a6e 100644
--- a/bog-readme.org
+++ b/bog-readme.org
@@ -5,6 +5,16 @@ Bog is a system for taking research notes in [[http://orgmode.org/][Org mode]].
research-specific features, nearly all of which are focused on managing
and taking notes with Org, not on writing research articles with Org.
+* Installation
+
+Bog is available on [[http://melpa.milkbox.net/][MELPA]].
+
+To enable Bog in all Org buffers, add it to =org-mode-hook=.
+
+#+begin_src emacs-lisp
+ (add-hook 'org-mode-hook 'bog-mode)
+#+end_src
+
* Workflow
Many people use Org for taking research notes, and there are some really