Update: README

This commit is contained in:
nold 2022-05-01 19:59:57 +02:00
parent 146a0abe2f
commit e733c6af80

View file

@ -3,18 +3,35 @@ This is my personal linux home directory configuration.
Use at your own risk! Use at your own risk!
## Usage ## Quickstart
Setting up this configuration is as simple as it gets: Setting up this configuration is as simple as it gets:
``` bash ``` bash
git clone https://git.nold.in/nold/homedir-config ~/.config/homedir git clone https://git.nold.in/nold/dotfiles
cd ~/.config/homedir && bash setup.sh cd dotfiles && bash setup.sh
``` ```
## Update To Update everything just run `setup.sh` again.
Updates all git-repos, vim Plugins, etc. ## Structure
``` bash ### bashrc
bash ~/.config/homedir/update.sh ... well ... `~/.bashrc`... will not be linked unlike files contained in `dotfiles` directory, but `source`d. Leaving the local `~/.bashrc` intact.
```
### config
Directories the will be linked to `~/.config/${name}`.
### configfile
Only files from this directory tree will be linked, to the same directory under `~/.config`
### dotfiles
Files that are directly located under `$HOME`.
### fonts
Fonts that will be copied to `~/.fonts`
### hosts
Custom additions to bashrc for specific hostnames. If no specific host is found in `hosts/$(hostname -s)`, `any` will be used.
### requirements.txt
Python libs to install using `pip3`.