summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorSomelauw <Somelauw>2017-02-25 14:55:27 +0100
committerSomelauw <Somelauw>2017-02-25 15:20:32 +0100
commita93b383f17d5537660fae574e9bd983d00c00df7 (patch)
treece6695c0ad313f5ee3e2734878aebc2fad704417 /README.org
parent4e1cd85ecfedee31026f4e6f9fa56ca76416e6cf (diff)
Add an example configuration file
Diffstat (limited to 'README.org')
-rw-r--r--README.org58
1 files changed, 30 insertions, 28 deletions
diff --git a/README.org b/README.org
index 2895d40..348cd3b 100644
--- a/README.org
+++ b/README.org
@@ -13,26 +13,6 @@ This is an extended and actively maintained version of https://github.com/edwtjo
- [X] insert mode bindings
- [X] table support
-** Requirements
-
- - org-mode, git://orgmode.org/org-mode.git
- - evil-mode, https://bitbucket.org/lyro/evil
- - evil-leader, https://github.com/cofi/evil-leader.git
-
-** Installation
-
- #+BEGIN_SRC sh
- mkdir -p ~/.emacs.d/plugins; git clone git://github.com/somelauw/evil-org-improved.git ~/.emacs.d/plugins/evil-org-mode
- #+END_SRC
-
-*** emacs.el
-
- #+begin_src emacs-lisp
- (add-to-list 'load-path "~/.emacs.d/plugins/evil-org-mode")
- (require 'evil-org)
- (evil-org-set-key-theme '(textobjects insert additional))
- #+end_src
-
** Keybindings
|----------------+---------------------------|
@@ -53,20 +33,42 @@ This is an extended and actively maintained version of https://github.com/edwtjo
[[file:doc/keythemes.org][Full overview of bindings and configuration]]
-** License
+** Requirements
- Gnu General Public License v3.0, http://www.gnu.org/copyleft/gpl.html
+ - org-mode, git://orgmode.org/org-mode.git
+ - evil-mode, https://bitbucket.org/lyro/evil
+ - evil-leader, https://github.com/cofi/evil-leader.git
-** See also
+** Installation
-*** http://orgmode.org/
- The official org-mode website
+ #+BEGIN_SRC sh
+ mkdir -p ~/.emacs.d/plugins; git clone git://github.com/somelauw/evil-org-improved.git ~/.emacs.d/plugins/evil-org-mode
+ #+END_SRC
+
+*** emacs.el
+
+ #+begin_src emacs-lisp
+ (add-to-list 'load-path "~/.emacs.d/plugins/evil-org-mode")
+ (require 'evil-org)
+ (evil-org-set-key-theme '(textobjects insert additional))
+ #+end_src
+
+ For a more elaborate setup, take a look at [[file:doc/example_config.el][this example]].
+
+** See also
-*** [[https://github.com/edwtjo/evil-org-mode][org-mode by edwtjo]]
+ - [[https://github.com/edwtjo/evil-org-mode][org-mode by edwtjo]]
Original org-mode plugin by edwtjo from which this project was forked
-*** https://github.com/GuiltyDolphin/org-evil
+ - [[https://github.com/GuiltyDolphin/org-evil][org-evil by GuiltyDolphin]]
Alternative integration of evil and org with different keybindings
-*** [[http://orgmode.org/orgcard.pdf]]
+ - http://orgmode.org/
+ The official org-mode website
+
+ - [[http://orgmode.org/orgcard.pdf]]
A handy cheat sheet, even if using this plugin
+
+** License
+
+ Gnu General Public License v3.0, http://www.gnu.org/copyleft/gpl.html