readme: better description

This commit is contained in:
2019-07-17 10:18:39 +01:00
parent e9ecbb8f6f
commit 0a85278f9f

View File

@@ -1,17 +1,22 @@
# alacritty-config
A simple Python script to simplify configuring my alacritty.
A simple Python script to simplify configuring my alacritty. Also comes with a GUI.
## 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.
different `INSTALL_DIR` if you like. If you want the GUI as well, run `make gui`.
Uninstall it using `make uninstall`.
## Usage
Depending on your sensibilities, you might want to configure your terminal using the
[CLI](#cli) or the [GUI](#gui).
### CLI
`alacritty-config` has three different modes: show, add, and delete.
Calling the program without any arguments will dump your entire config: youre in show
@@ -48,10 +53,10 @@ $ alacritty-config tabspaces '"delete"'
# Set tabspaces to "delete", which wont work
```
## TODO
### GUI
Im writing a GUI for the configuration currently, but its far from complete. The parts
that are already wrapped should work, though!
The GUI is somewhat more self-explanatory. You start it by running `alacritty-config-gui`.
The basic unit of order is the tab, and there are expandable sections for you convenience.
<hr/>