diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 25 insertions, 7 deletions
@@ -1,10 +1,28 @@ -# dotfiles -- README -# author: johannst +# dotfiles -Currently no installer available! +Installer framework only availabl in bash. -- **print_bash_color** - - display available colors +### Control installation +Installation of the config files is controlled with the `install.config` file. The format of a line in the file is as follows: +``` +[yYnN] - <config_tag> +``` +Where `yY` means to install the config file and `nN` means to skip installation for this config file. +Any line not matching the regex `^[yYnN][[:blank:]]?-` is ignored. -- **vim/install_vundle.sh**: - - install Vundle vim package manager + +The installation process is triggered by executing the `install` file. + +### Adapt installation of config files +The installation of a particular config file can be adapted by modifying the corresponding installer function. +Follow the `<config_tag>` in the `gToolsConfig` map (defined in `install`) to find the name of the installer function. The name is the third entry for the tag. + +### Adding additional config files + +First add an entry in the `gToolsConfig` map in the `install` file. Entries have the following format: +``` +"<config_tag>:<dep_binary>:<installer_function_name>" +``` +Then create and implement the installer function with the name provided in the newly created entry. + +Then create an entry in the `install.config` file with the tag that matches the tag provided in the `gToolsConfig`. |