From e733c6af80a4bb0870fc41a824aad1c8940b813f Mon Sep 17 00:00:00 2001 From: nold Date: Sun, 1 May 2022 19:59:57 +0200 Subject: [PATCH] Update: README --- README.md | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a640a6f..8519aff 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,35 @@ This is my personal linux home directory configuration. Use at your own risk! -## Usage +## Quickstart Setting up this configuration is as simple as it gets: ``` bash -git clone https://git.nold.in/nold/homedir-config ~/.config/homedir -cd ~/.config/homedir && bash setup.sh +git clone https://git.nold.in/nold/dotfiles +cd dotfiles && bash setup.sh ``` -## Update +To Update everything just run `setup.sh` again. -Updates all git-repos, vim Plugins, etc. +## Structure -``` bash -bash ~/.config/homedir/update.sh -``` +### bashrc +... 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`.