luca
/
dotfiles
1
0
Fork 0
Code

update readme

This commit is contained in:
Luca Bilke 2024-01-18 11:30:33 +01:00
parent fc700acdf9
commit da7cb16025
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,17 +1,11 @@
These are the dotfiles that I use on an Ubuntu, Arch and Void machine.
These are the dotfiles that I use on Void Linux.
I keep them on a selfhosted git server for easy synchronization, and mirror them to github so that others can use parts of them as well.
## Installation?
I'd advise against using my setup currently. I am currently in the process of writing a script that will automatically install the various software dependencies of my setup, which will be usable on Void Linux systems. Once that is finished it might actually make sense to install them.
Theoretically they could be installed by cloning this repo to ~/.dotfiles and running ~/.dotfiles/.local/bin/dotsync.
This script requires gnu stow to be installed, which symlinks the dotfiles to the correct locations.
The script will download the [submodules](.gitmodules) that exist in this repo. This includes the source code for a modified dwm, dmenu and dwmblocks, which can be optionally compiled and installed by the dotsync script.
## Installation
I've written a [script](https://github.com/ssnailed/bootstrapper) that will configure a fresh void installation to be used with these dotfiles.
You can also clone the repo to `~/.local/share/stow/dots` and run `~/.local/share/stow/dots/.local/bin/dotsync` to install them on an existing installation, but I'm sure that a few things would break.
## Warnings
My [.zprofile](.config/zsh/profile) automatically starts the [custom xinit script](.local/bin/startgraphical) if logged in on TTY1 and no other X server is running. This is because I use the default [getty](https://en.wikipedia.org/wiki/Getty_(Unix)) and want to automatically start dwm after logging in.
The [custom xinit script](.local/bin/startgraphical) runs the [remaps script](.local/bin/remaps) which in turn loads a [modified dvorak keymap](.config/X11/xkb). An [older iteration](.local/bin/trash/remaps) of this script is a bit saner and allows toggling between the default keymaps.
The [remaps script](.local/bin/remaps) is also automatically run by the [remapd script](.local/bin/daemons/remapd) whenever a keyboard is plugged in. This script is started during xinit [here](.config/X11/xsession.d/80auto-start).
My [.zprofile](.config/zsh/profile) automatically runs xinit if logged in on TTY1 and no other X server is running. This is because I use the default [getty](https://en.wikipedia.org/wiki/Getty_(Unix)) and want to automatically start dwm after logging in.
If any key mappings seem strange, it's because I use the dvorak keyboard layout.