Update README

This commit is contained in:
Gender Demon 2022-05-28 18:16:54 +01:00
parent e6390fc426
commit 64c5908fd4
1 changed files with 10 additions and 43 deletions

53
README
View File

@ -1,51 +1,18 @@
# cren's cracking config
These files record the configurations I use for various Linux/unix program.
(Such files are also known as dotfiles.)
Please find enclosed configuration files written by me to customise
various programs I use.
I make changes to this repository regularly. Its contents are in no
way stable.
Also enclosed is fehbg, a script that was generated automatically by
a command I ran. I include it for completeness: without it, this
repository would not properly record my entire system configuration.
All the files in this repository are available under licences which
allow free modification and redistribution.
## Programs for which configuration files exist
Files authored by me are licenced under the BSD 3-clause licence. The
full text can be found in the LICENCE file enclosed.
### Programs I use regularly
* zsh (Z shell)
* nvim (neovim)
* the `river` Wayland compositor
* the `foot` terminal emulator
### Programs I no longer use regularly
Because I don't use these programs regularly, the configuration files
for these might be for an older version of the program, and aren't
maintained.
* dwm (dynamic window manager)
* the wallpaper-setting component of feh
* xorg x server
* alacritty
* bspwm (binary space partition window manager)
* sxhkd (simple x hotkey daemon)
## Fair warning
I write these files for myself, and not for portability. If you try
to use them yourself, you may encounter problems.
Further, I regularly change the contents of these files. If you try
to always use the latest version of each file, you may find that
program configurations change significantly over time.
## Freely redistributable
Files not authored by me may be available under different licences, but
all of them allow free modification and redistribution.
All the files written by me in this repository are licenced under the
BSD 3-clause licence. The full text can be found in the LICENCE file
enclosed.
All the files **not** written by me in this repository are licenced
under licences that allow free modification and redistribution. All
files not written by me are accompanied by their licence(s). Such
accompanying licences are headed with a note explaining which files
they licence.