adds readme

This commit is contained in:
xesc 2023-12-09 20:33:05 +01:00
parent aac1f2f7e0
commit 4ca8dac6dc

29
readme.md Normal file
View file

@ -0,0 +1,29 @@
# Configs
Welcome to my configs, feel free to use and modify them as you like!
To install all of them to your system, just `$ make install`.\
If you just want some of them, use `$ make <directory_name>` for a specific application.
---
### You want to know what would happen on install without installing anything yet?
For a dry-run of any of the targets, just prepend `-dry` to the targets name.
> Note: \
> This management relies on GNU Stow, so to work properly, please ensure you have 'stow' installed...
---
### You don't want to use a config anymore?
Prepend `-uninstall` to any config installed via the `install`-command from earlier.
---
### To much stuff you don't need?
Check out `https://git.xesc.de/xesc` for the individual repos of the applicatons.
---
Have fun :)