summary refs log tree commit diff
diff options
context:
space:
mode:
authorFranck Cuny <franckcuny@gmail.com>2016-02-17 06:05:04 -0800
committerFranck Cuny <franckcuny@gmail.com>2016-02-17 06:05:04 -0800
commit8d4169f2d1791778f4cd977d446f99932d5dd785 (patch)
treedd3f2e110c73fa163667b47382ad6a90052f8b43
parent[emacs] Rename a few functions and update bindings (diff)
downloademacs.d-8d4169f2d1791778f4cd977d446f99932d5dd785.tar.gz
[emacs] Remove the documentation from README.
Add a 'doc' directory with the documentation for emacs, bash and git.
-rw-r--r--README.org82
-rw-r--r--docs/bash.org4
-rw-r--r--docs/emacs.org75
-rw-r--r--docs/git.org4
4 files changed, 92 insertions, 73 deletions
diff --git a/README.org b/README.org
index 792dd47..0282278 100644
--- a/README.org
+++ b/README.org
@@ -1,6 +1,11 @@
+#+AUTHOR: Franck Cuny
+#+TITLE: README
+#+STARTUP: indent
+#+STARTUP: hidestars
+
 * Home
 
-My personal configuration files.
+My personal configuration files for [[https://www.gnu.org/software/emacs/][emacs]], [[https://www.gnu.org/software/bash/][bash]] and [[https://git-scm.com/][git]].
 
 ** Installation
 
@@ -10,6 +15,8 @@ To install the dotfiles:
 make install
 #+END_SRC
 
+** Maintain the configuration
+
 To check for dead symlinks:
 
 #+BEGIN_SRC sh :results silent
@@ -22,78 +29,6 @@ To remove dead symlinks:
 make clean-dead
 #+END_SRC
 
-** Emacs
-
-*** Bindings
-
-| Binding      | Description                                    |
-|--------------+------------------------------------------------|
-| M-j          | Join lines                                     |
-| super-return | Toggle fullscreen                              |
-| C-h f        | Display help about a function                  |
-| C-h k        | Which function is binded to a sequence of keys |
-| M-$          | Flyspell suggestion                            |
-| C-s          | Regex search with an overview                  |
-
-*** smartparens
-
-| Binding       | Action                                                                         |
-|---------------+--------------------------------------------------------------------------------|
-| C-M-f         | Move forward across one expression                                             |
-| C-M-b         | Move backward across one expression                                            |
-| C-M-d         | Move forward down one level                                                    |
-| C-M-a         | Move backward down one level                                                   |
-| C-S-a         | Jump to the beginning of the sexp                                              |
-| C-S-e         | Jump to the end of the sexp                                                    |
-| C-M-f         | Move across one expression                                                     |
-| C-M-b         | Move backward across one expression                                            |
-| C-M-u         | Move backward out of one level                                                 |
-| C-M-t         | Transpose the expression around the point                                      |
-| C-M-n         | Move forward to the beginning of the next expression                           |
-| C-M-p         | Move backward to the end of the previous expression                            |
-| C-M-k         | Kill the expression                                                            |
-| C-M-w         | Copy the expression                                                            |
-| M-<delete>    | unwrap the expression                                                          |
-| M-<backspace> | unwrap the previous expression                                                 |
-| M-<right>     | Add following expression in current expression                                 |
-| M-<left>      | Remove the last expression in the current list                                 |
-| M-S-<right>   | Add the sexp preceding the current list in it by moving the opening delimiter. |
-| M-S-<left>    |                                                                                |
-| M-d           | Unwrap the current list.                                                       |
-
-*** Modes
-
-**** Magit
-
-| Binding | Description  |
-|---------+--------------|
-| C-x g   | Magit status |
-|         |              |
-
-**** Projectile
-
-| Binding | Description                                 |
-|---------+---------------------------------------------|
-| C-c p k | Kill all the buffers related to the project |
-| C-c p p | Switch to a project                         |
-| C-c p f | Find file in a project                      |
-| C-c p b | Switch to a buffer of the project           |
-
-**** Puppet
-
-| Binding | Description                           |
-|---------+---------------------------------------|
-| C-c C-a | Align parameters in the current block |
-| C-c C-' | Toggle ' and "                        |
-|         |                                       |
-
-**** Scheme
-
-| Binding     | Description             |
-|-------------+-------------------------|
-| C-u C-a C-z | Load buffer in the REPL |
-|             |                         |
-
 ** Tasks
 *** TODO Run magit in fullscreen ?
 *** TODO Add word / sign / sentence count for markdown in the status line
@@ -103,3 +38,4 @@ make clean-dead
 *** TODO BUILD files are Python files
 *** TODO Emacs' git configuration
     Add binding for git diff, git commit, and configure correctly git commit mode.
+*** TODO Sometimes aurora files are not seen as Python ?
diff --git a/docs/bash.org b/docs/bash.org
new file mode 100644
index 0000000..2e2154a
--- /dev/null
+++ b/docs/bash.org
@@ -0,0 +1,4 @@
+#+AUTHOR: Franck Cuny
+#+TITLE: bash documentation
+#+STARTUP: indent
+#+STARTUP: hidestars
diff --git a/docs/emacs.org b/docs/emacs.org
new file mode 100644
index 0000000..a8f436d
--- /dev/null
+++ b/docs/emacs.org
@@ -0,0 +1,75 @@
+#+AUTHOR: Franck Cuny
+#+TITLE: Emacs documentation
+#+STARTUP: indent
+#+STARTUP: hidestars
+
+* Bindings
+
+General key bindings.
+
+| Binding      | Description                                    |
+|--------------+------------------------------------------------|
+| M-j          | Join lines                                     |
+| super-return | Toggle fullscreen                              |
+| C-h f        | Display help about a function                  |
+| C-h k        | Which function is binded to a sequence of keys |
+| M-$          | Flyspell suggestion                            |
+| C-s          | Regex search with an overview                  |
+
+** smartparens
+
+| Binding       | Action                                                                         |
+|---------------+--------------------------------------------------------------------------------|
+| C-M-f         | Move forward across one expression                                             |
+| C-M-b         | Move backward across one expression                                            |
+| C-M-d         | Move forward down one level                                                    |
+| C-M-a         | Move backward down one level                                                   |
+| C-S-a         | Jump to the beginning of the sexp                                              |
+| C-S-e         | Jump to the end of the sexp                                                    |
+| C-M-f         | Move across one expression                                                     |
+| C-M-b         | Move backward across one expression                                            |
+| C-M-u         | Move backward out of one level                                                 |
+| C-M-t         | Transpose the expression around the point                                      |
+| C-M-n         | Move forward to the beginning of the next expression                           |
+| C-M-p         | Move backward to the end of the previous expression                            |
+| C-M-k         | Kill the expression                                                            |
+| C-M-w         | Copy the expression                                                            |
+| M-<delete>    | unwrap the expression                                                          |
+| M-<backspace> | unwrap the previous expression                                                 |
+| M-<right>     | Add following expression in current expression                                 |
+| M-<left>      | Remove the last expression in the current list                                 |
+| M-S-<right>   | Add the sexp preceding the current list in it by moving the opening delimiter. |
+| M-S-<left>    |                                                                                |
+| M-d           | Unwrap the current list.                                                       |
+
+* Modes
+** Magit
+
+| Binding | Description  |
+|---------+--------------|
+| C-x g   | Magit status |
+|         |              |
+
+** Projectile
+
+| Binding | Description                                 |
+|---------+---------------------------------------------|
+| C-c p k | Kill all the buffers related to the project |
+| C-c p p | Switch to a project                         |
+| C-c p f | Find file in a project                      |
+| C-c p b | Switch to a buffer of the project           |
+
+** Puppet
+
+| Binding | Description                           |
+|---------+---------------------------------------|
+| C-c C-a | Align parameters in the current block |
+| C-c C-' | Toggle ' and "                        |
+|         |                                       |
+
+** Scheme
+
+| Binding     | Description             |
+|-------------+-------------------------|
+| C-u C-a C-z | Load buffer in the REPL |
+|             |                         |
diff --git a/docs/git.org b/docs/git.org
new file mode 100644
index 0000000..f10bc7b
--- /dev/null
+++ b/docs/git.org
@@ -0,0 +1,4 @@
+#+AUTHOR: Franck Cuny
+#+TITLE: git documentation
+#+STARTUP: indent
+#+STARTUP: hidestars