diff --git a/config/README.txt b/config/README.txt index 53ec785..96ffa3c 100644 --- a/config/README.txt +++ b/config/README.txt @@ -1,6 +1,17 @@ -The config directory stores configuration files for various apps, utils and systems. +Lissy93/Dotfiles - Config ⚙️ +---------------------------- + +List of configuration files for various apps, utils and systems. Generic configs which are used across all systems (e.g. .gitconfig, .bashrc, .wgetrc) are stored in the root of the config directory, whereas files which are only used on certain systems (like MacOS) or by certain applications (like Firefox's user.js) are -kept in category-specific directories (e.g. macos, desktop-apps, etc). +kept in category-specific directories (e.g. macos, desktop-apps, gnome, etc). + +The location on disk that files should be symlinked to is specified in symlinks.yml +Run the install.sh script to apply settings based on system type and user preferences + +Important: Take care to read through files thouroughly before applying any changes. + +For full documentation, see: https://github.com/Lissy93/dotfiles +Licensed under MIT (C) Alicia Sykes 2022