From 65edd0b02d43597adbd3d11403a96905073c94a8 Mon Sep 17 00:00:00 2001 From: saibotk Date: Thu, 6 Dec 2018 20:04:35 +0100 Subject: [PATCH] Add description to readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a7a0a6..59dd65f 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# My Dotfiles +# My Dotfiles with an installer + +These are just my own config files for various applications like atom, vim and zsh... +It also contains an installation script "setup.sh" to easily apply all of the settings and install some needed tools like +Vundle. + +## Usage +If you want to install and apply all of the settings you just need to run: +``` +cd ~ +git clone https://github.com/saibotk/.dotfiles +./setup.sh +``` + +## Atom packages +If you plan on using you own atom package list, you can modify the "atom/packages.list". +The install script will try to find that file and automatically install all packages. + +You can export the package list with: +``` +apm list --installed --bare > ~/.dotfiles/atom/packages.list +``` +