Add README.md
authorChristian Hofstaedtler <ch@grml.org>
Wed, 22 Jun 2011 21:21:59 +0000 (23:21 +0200)
committerChristian Hofstaedtler <ch@grml.org>
Wed, 22 Jun 2011 21:21:59 +0000 (23:21 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..a778d6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+grml-etc-core
+=============
+
+This repository contains the core /etc files for the Grml system.
+
+While generally these files are distributed as a Debian package, named
+"grml-etc-core", they are also useful on other systems.
+
+To use the most important files for your user, use the following commands:
+
+    # IMPORTANT: please note that you might override existing
+    # configuration files in the current working directory!
+    wget -O .screenrc     http://git.grml.org/f/grml-etc-core/etc/grml/screenrc_generic
+    wget -O .vimrc        http://git.grml.org/f/grml-etc-core/etc/vim/vimrc
+    wget -O .zshrc        http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
+
+
+Or, on operating systems without wget:
+
+    # IMPORTANT: please note that you might override existing
+    # configuration files in the current working directory!
+    curl -o .screenrc     http://git.grml.org/f/grml-etc-core/etc/grml/screenrc_generic
+    curl -o .vimrc        http://git.grml.org/f/grml-etc-core/etc/vim/vimrc
+    curl -o .zshrc        http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
+
+
+Further information is available from http://grml.org/console/
+