path: root/README.markdown
diff options
authorTom Ryder <tom@sanctum.geek.nz>2012-05-28 09:54:53 +1200
committerTom Ryder <tom@sanctum.geek.nz>2012-05-28 09:54:53 +1200
commit8a633a3cbe982e356a661f5d371286bc63f4a0f9 (patch)
treef7286010cb605adf6d9653f63c6499053a73eac0 /README.markdown
parentUnmap Q in normal mode (Ex mode) (diff)
Rename, reorganise, hard-wrap README file.
Sorry to anyone watching the repository, I'm still kind of enthralled with Markdown.
Diffstat (limited to 'README.markdown')
1 files changed, 28 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 00000000..3490e4f3
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,28 @@
+Tom Ryder's personal repository of dotfiles. This is for those settings that
+migrate well from machine to machine and that I consider safe to publish.
+These are not really built for other people to use, but if you know a thing or
+two about Bash and Vim, you won't struggle.
+ $ cd
+ $ git clone git://github.com/tejr/dotfiles.git .dotfiles
+There's an installation script, but it hoses your existing files, so don't run
+it without reading it first. You'll also need to have a recent enough version
+of Git to support [submodules][1].
+ $ .dotfiles/install
+Copyright (c) [Tom Ryder][2]. Distributed under an [MIT License][3]. Buy me a
+beer sometime.
+[1]: http://git-scm.com/book/en/Git-Tools-Submodules
+[2]: http://www.sanctum.geek.nz/about/tom-ryder
+[3]: http://www.opensource.org/licenses/MIT