summary refs log tree commit diff
diff options
context:
space:
mode:
authorFranck Cuny <franckcuny@gmail.com>2016-02-15 17:00:22 -0800
committerFranck Cuny <franckcuny@gmail.com>2016-02-15 17:00:22 -0800
commit41160dd78063292d9810605c486a7d515fba28d3 (patch)
treedabc1782f01737571f94f717b625050365b21ac6
parent[emacs] Start a configuration for org-mode. (diff)
downloademacs.d-41160dd78063292d9810605c486a7d515fba28d3.tar.gz
Update the README.
-rw-r--r--README.org93
1 files changed, 61 insertions, 32 deletions
diff --git a/README.org b/README.org
index 48e5a43..2c1d199 100644
--- a/README.org
+++ b/README.org
@@ -2,6 +2,26 @@
 
 My personal configuration files.
 
+** Installation
+
+To install the dotfiles:
+
+#+BEGIN_SRC sh :results silent
+make install
+#+END_SRC
+
+To check for dead symlinks:
+
+#+BEGIN_SRC sh :results silent
+make check-dead
+#+END_SRC
+
+To remove dead symlinks:
+
+#+BEING_SRC sh :results silent
+make clean-dead
+#+END_SRC
+
 ** Emacs
 
 *** Bindings
@@ -15,42 +35,42 @@ My personal configuration files.
 | M-$          | Flyspell suggestion                            |
 | C-s          | Regex search with an overview                  |
 
-For smartparens
-
-Key | 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
+*** 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
+**** Projectile
 
 | Binding | Description                                 |
 |---------+---------------------------------------------|
@@ -59,7 +79,7 @@ M-d | Unwrap the current list.
 | C-c p f | Find file in a project                      |
 | C-c p b | Switch to a buffer of the project           |
 
-*** Puppet
+**** Puppet
 
 | Binding | Description                           |
 |---------+---------------------------------------|
@@ -67,10 +87,19 @@ M-d | Unwrap the current list.
 | C-c C-' | Toggle ' and "                        |
 |         |                                       |
 
-*** Scheme
+**** 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
+*** TODO Take a look at "highlight-indent-guides" for emacs
+*** TODO How to update Emacs on OSX ?
+*** TODO Add puppet-lint to Flymake
+*** TODO BUILD files are Python files
+*** TODO Emacs' git configuration
+    Add binding for git diff, git commit, and configure correctly git commit mode.