From 4694a00aad74000e7f4be2dc80d737d854311c46 Mon Sep 17 00:00:00 2001 From: koumakpet Date: Sat, 14 Mar 2020 13:53:34 +0100 Subject: [PATCH] Updated README for python --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 80912f6..68aa81f 100755 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ # Dotfiles -## What can it do? + +## What can it do + * Automate your daily tasks with handy aliases * Use nice prompt that shows you your git branch and command failure * Quickly install common packages with just 1 script * Get a nice VIM interface -* Also works for ZSH Shell * Adjust the settings any way you want +* You are in charge (install what you want, remove what you don't like) -## How to use it? -Clone this repository into your home floder (~/dotfiles)
-(Note that it has to be installed in your home directory, otherwise the script will not work!)
-`$ git clone https://github.com/koumakpet/dotfiles`
-Before you run **install.sh**, you should take a look at the files included and adjust them however you like. -All files which will be added are in files/ directory -When you are prepared, you can run installer.sh file in \~/dotfiles
-`$ sh ~/dotfiles/instal.sh` +## Requirements: + +Note that it is required to have Python 3 installed to run this. + +## How to use it + +Clone this repository anywhere you like
+`$ git clone https://github.com/koumakpet/dotfiles`
+ +Before you run **installer.py**, you should take a look at the files included and adjust them however you like. +All files which will be added are in files/ directory. +You can remove files which you don't want, or adjust them in any way.
+When you are prepared, you can run installer.py
+`$ python3 ~/dotfiles/instal.sh` (assuming you cloned repository to your home directory)