add readme

This commit is contained in:
LordMZTE 2023-05-04 08:36:57 +02:00
parent 198674c60a
commit 27ada010e7
Signed by: LordMZTE
GPG key ID: B64802DC33A64FF6

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# My dotfiles
I'm actually making the claim now that this repo might just be the most hilariously complicated configuration in existance.
This is my system configuration, built mostly for arch & SystemD based linuxes.
Here's some useful facts:
- Config files are generated using confgen, my config file template engine. Options that can be changed are in cg_opts.lua. This makes for a centralized place for common options like fonts. This allows for complete deduplication.
- The neovim config is written in part Zig (yes, really) and part fennel. Use `just setup-nvim-config` to build and install it.
- Lua/Fennel files in the nvim config are compiled to lua bytecode.
- Theres a `justfile` with convenient functions such as installing scripts, building the config and setting up the neovim configuration.
- I have a lot of scripts, written in Zig, Racket and some in shell.