README.rst: add one

Basic overview of what's included, and how to "install" it.

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..43645c9
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,40 @@
+Personal `GNU Emacs <https://www.gnu.org/software/emacs/>`_
+configuration
+
+Overview
+========
+
+This is my personal emacs configuration, and a few elisp functions
+that I use frequently.
+
+.emacs
+  My dot-emacs file. Usually symlinked directly into ``$HOME``, which
+  is why it is a hidden file. Puts the rest of the repository onto your
+  emacs path. This is where most settings are tweaked.
+auto-modes.el
+  A list of file extensions and the modes that should be used to
+  open them.
+diff-buffer-against-file.el
+  Shows you the changes you've made to a file that you have open in a
+  buffer.
+latex-query-replace-regexp-math.el
+  Regexp find & replace, but only within equations. Imagine you want
+  to replace "x".
+mode-hooks.el
+  Loads everything in the ``mode-hooks/`` directory.
+mode-hooks/*.el
+  Nonstandard configuration for various emacs modes, applied via hook
+  when those modes are enabled.
+
+
+Installation
+============
+
+I use the included ``.emacs`` as *my* ``.emacs``:
+
+.. code-block:: shell
+
+  $ ln -s /path/to/repo/.emacs ~/.emacs
+
+This makes everything else available automatically. If you don't want
+to do that, you'll have to pick and choose.