dotfiles/README.md

-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-

`README.md`

---------
# Hyacinthe Cartiaux Dot Files

These are my configuration files for `bash`, `git`, `vim` etc. so as to set up a
system the way I like it.

In the sequel, when providing a command, `$>` denotes a prompt and is not part
of the commands.

## Pre-requisites

You should install the following elements to use the full functionality of
these config files:

* zsh
* zsh-completions
* bash
* bash-completions
* screen
* tmux
* git
* subversion
* vim
* ssh

## Installation

Run the following commands:

    $> git clone https://github.com/hcartiaux/dotfiles.git ~/.dotfiles
    $> ~/.dotfiles/install.sh

## Environment

I am running primarily on Archlinux, otherwise on Debian so these config files
will likely work on your system, eventually with a little tweaking.

## BUGS

Find a bug? Just post a new issue on [Github](https://github.com/hcartiaux/dotfiles/issues)!

## DISCLAIMER

My `dotfiles` are distributed in the hope that they will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

## AUTHOR

Hyacinthe Cartiaux, using various contributions on the Internet, in particular:

*  [Sebastien Varrette dotfiles](https://github.com/Falkor/dotfiles)
*  [Derek Payton dotfiles](http://bitbucket.org/dmpayton/dotfiles/src/tip/.bashrc)
*  [Ryan Tomayko dotfiles](https://github.com/rtomayko/dotfiles/blob/rtomayko/.bashrc)
*  [Sebastien Badia vim configuration](https://github.com/sbadia/grimvim)

As often, I release these files under GNU GPL Licence v3.
You may use, modify, and/or redistribute them under the terms of the GPL Licence v3.

-------