initial

README.md

@@ -0,0 +1,59 @@
+# alacritty-config
+
+A simple Python script to simplify configuring my alacritty.
+
+## Installation
+
+You can install `alacritty-config` by cloning this repository and running  `make
+install`. By default, it will be installed in `/usr/local/bin`, but you can set a
+different `INSTALL_DIR` if you like.
+
+Uninstall it using `make uninstall`.
+
+## Usage
+
+`alacritty-config` has three different modes: show, add, and delete.
+
+Calling the program without any arguments will dump your entire config: you’re in show
+mode, but you haven’t selected anything. If you want to know the value of the `tabspaces`
+property, call `alacritty-config` with just that argument. If you want to know the action
+of your third key binding, call it with `key_bindings.2.action`—we’re 0-indexed.
+
+```
+$ alacritty-config
+<your entire config>
+
+$ alacritty-config tabspaces
+8 # or whatever you set it to
+
+$ alacritty-config key_bindings.2.action
+Paste # or whatever you set it to
+```
+
+If you want to delete a property, simply add `delete`.
+
+```
+$ alacritty-config tabspaces delete
+# Poof! It’s gone!
+```
+
+If you want to add or edit a property, simply add a different YAML-parseable property.
+If you want to set something to `delete`, simply quote it.
+
+```
+$ alacritty-config tabspaces 4
+# Set tabspaces to 4
+
+$ alacritty-config tabspaces '"delete"'
+# Set tabspaces to "delete", which won’t work
+```
+
+## TODO
+
+Oh, so much! Ideally, I’d like a GUI at least for all the colorful properties and for
+selecting fonts. For now the tool is simple and usable enough to be useful, but a simple
+GUI would definitely give this a better UX. Another time.
+
+<hr/>
+
+Have fun!