add readme

markdown parsing

add readme

add readme

.stow-local-ignore

@@ -1,4 +1,5 @@
-TODO
+README\.md
+TODO\.md
 \.git
 \.gitignore
 \.gitmodules

README.md

@@ -0,0 +1,17 @@
+These are the dotfiles that I use on an Ubuntu and an Arch machine.
+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 Arch and Ubuntu 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.
+
+## 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).

TODO

@@ -1,7 +0,0 @@
--- TODO -- 
-Create a better bitwarden integration
-Generate .ssh/config frome netbox using a playbook
-Remove username from ssh completion
-
--- FIX --
-sb-playerctl trailing dash when no artist

TODO.md

@@ -0,0 +1,6 @@
+# TODO
+- [ ] Create a better bitwarden integration
+- [ ] Remove username from ssh completion
+
+# FIX
+- [ ] sb-playerctl trailing dash when no artist