Updated README for python

This commit is contained in:
koumakpet 2020-03-14 13:53:34 +01:00
parent 9d636e0de4
commit 4694a00aad

View file

@ -1,17 +1,25 @@
# Dotfiles # Dotfiles
## What can it do?
## What can it do
* Automate your daily tasks with handy aliases * Automate your daily tasks with handy aliases
* Use nice prompt that shows you your git branch and command failure * Use nice prompt that shows you your git branch and command failure
* Quickly install common packages with just 1 script * Quickly install common packages with just 1 script
* Get a nice VIM interface * Get a nice VIM interface
* Also works for ZSH Shell
* Adjust the settings any way you want * 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? ## Requirements:
Clone this repository into your home floder (~/dotfiles)<br>
(Note that it has to be installed in your home directory, otherwise the script will not work!)<br> Note that it is required to have Python 3 installed to run this.
## How to use it
Clone this repository anywhere you like <br>
`$ git clone https://github.com/koumakpet/dotfiles` <br> `$ git clone https://github.com/koumakpet/dotfiles` <br>
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 Before you run **installer.py**, you should take a look at the files included and adjust them however you like.
When you are prepared, you can run installer.sh file in \~/dotfiles<br> All files which will be added are in files/ directory.
`$ sh ~/dotfiles/instal.sh` You can remove files which you don't want, or adjust them in any way. <br>
When you are prepared, you can run installer.py <br>
`$ python3 ~/dotfiles/instal.sh` (assuming you cloned repository to your home directory)