Author: Kyle Fuller <kyle@fuller.li> 2015-10-10 01:17:28 -0700 -0700
Committer: Kyle Fuller <kyle@fuller.li> 2015-10-10 01:17:28 -0700 -0700
Commit: 98f5757459336892bbb66092ba696600bf01c8d6
Parent: b5c7d7a4dff7ff7e6d1758e7a50438e9a5136f49
Update README
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 6b9238126164919c9b1d369b0e2547033a856318..0000000000000000000000000000000000000000
--- a/LICENSE
+++ /dev/null
@@ -1,24 +0,0 @@
-Copyright (c) 2013, Kyle Fuller
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..6d7f871f6fbfbbdc0651b254bf09ca189e2dcf73
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# dotfiles
+
+See ["Organising dotfiles in a git repository"](https://fuller.li/posts/organising-dotfiles-in-a-git-repository/) for more info.
+
+## Installation
+
+Cloning the dotfiles:
+
+```shell
+$ alias home=git --work-tree=$HOME --git-dir=$HOME/.files.git
+$ home init
+$ home fetch
+$ home checkout master
+```
+
+Installing tools:
+
+```shell
+$ make
+```
+
diff --git a/README.rst b/README.rst
deleted file mode 100644
index fcef7695258c6f384bd1efbb34602e90c0abd3b5..0000000000000000000000000000000000000000
--- a/README.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-dotfiles
-========
-
-The dotfiles can be installed by git cloning the repository.
-
-.. code-block:: bash
-
- $ make
-
-.. code-block:: bash
-
- $ make osx