extern/dotfiles
1
0
Fork 0
mirror of https://github.com/Lissy93/dotfiles.git synced 2025-02-16 06:59:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updates config doc, wip

Browse Source
This commit is contained in:
Alicia Sykes 2022-11-27 13:23:34 +00:00
parent 186a35540a
commit 77e7436f92
1 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
config/README.txt
View File

@ -1,13 +1,25 @@
Lissy93/Dotfiles - Config ⚙️
----------------------------
List of configuration files for various apps, utils and systems.
> All configuration files for apps, utils and services used across *nix-based systems
config
├── desktop-apps/ # Config files for GUI applications
│ ├── firefox.user.js # Firefox (browser)
│ └── thunderbird.user.js # Thunderbird (mail client)
├── general/ # General config files for all *nix-based systems
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 thoroughly before applying any changes
And always make a backup of your pre-existing config files before over-writing them
Full source and documentation: https://github.com/Lissy93/dotfiles
Licensed under MIT (C) Alicia Sykes 2022 <https://aliciasykes.com>
---
config/
├── git/ # Git (version control) config files
├── tmux/ # Tmux (multiplexer) config, sessions, bindings and plugin list
├── vim/ # Vim (text editor) config, key bindings and plugin list
├── zsh/ # ZSH (shell) settings, aliases, utils and plugin list
├── general/ # All other config files for *nix-based systems
│ ├── .bashrc
│ ├── .gemrc
│ ├── .gitignore_global
@ -16,24 +28,15 @@ config
│ ├── .gitconfig
│ ├── .wgetrc
│ └── dnscrypt-proxy.toml
├── macos/
│ ├── launchpad.yml
│ ├── skhdrc
│ └── yabairc
├── macos/ # Configs for apps only used on MacOS
│ ├── launchpad.yml # The layout and folder structure of launchpad screen
│ ├── skhdrc # Hot keys for managing TWM
│ └── yabairc # Settings for tiling window manager
├── desktop-apps/ # Config files for GUI applications
│ ├── firefox.user.js # Firefox (browser)
│ └── thunderbird.user.js # Thunderbird (mail client)
├── themes/ # Color themes for various apps
│ ├── iterm #
│ └── warp #
└── README.txt
Generic configs which are used across all systems (e.g. .gitconfig, .bashrc, .wgetrc)
are stored in the root of the config directory, whereas groups of config files, for like
ZSH, Vim, Tmux etc are organized into directories.
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, 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 thoroughly before applying any changes.
Full source and documentation: https://github.com/Lissy93/dotfiles
Licensed under MIT (C) Alicia Sykes 2022 <https://aliciasykes.com>