Commit 2bc313bd authored by Guillaume Deflaux's avatar Guillaume Deflaux
Browse files

Update README.md

parent 0b322af7
......@@ -2,16 +2,16 @@
A GTK application that allows you to configure Regolith Linux without having to edit the config files manually.
The application parses the system defaults files in order to extract all the Xresources variables. The one assumption here (for now) is that the `~/.Xresource-regolith` file needs to exist and to `#include` the look related files. Then the application loads the `~/.config/regolith/Xresources` file where the user definitions are expected. The application writes that same file with the variables that do not have the default values from the system defaults. If you are using this file already your custom definitions will be kept.
The application parses the system default files in order to extract all the Xresources variables. The parse sequence is as follows:
The parse sequence is as follows:
1. `~/.Xresources-regolith`
2. `/etc/regolith/i3/config`
1. `~/.Xresources-regolith` or `/etc/regolith/styles/root` (In that order. First one found is used)
2. `~/.config/regolith/i3/config` or `/etc/regolith/i3/config` (In that order. First one found is used)
3. `/usr/share/i3xrocks/*`
4. `~/.config/regolith/Xresources`
Because the application parses the these files, it should be safe to upgrade Regolith.
Because the application parses the these files, it should be safe to upgrade Regolith. If you are already using `~/.config/regolith/Xresources` and/or `~/.Xresources-regolith` to override variables your custom definitions will be kept.
The application will write all the custom definitions to `~/.config/regolith/Xresources` (the file is generated by the application).
## Preview
......@@ -38,7 +38,7 @@ $ ninja
## Requirements
The application required that the `~/.Xresources-regolith` file `#include`s all look files. The best way is to run `regolith-look set <look>` on fresh install or make sure that you `~/.Xresources-regolith` file looks like:
If you are using `~/.Xresources-regolith`, the file must `#include` all look files. The best way is to run `regolith-look set <look>` on fresh install or make sure that you `~/.Xresources-regolith` file looks like:
```
#include "/etc/regolith/styles/cahuella/root"
......@@ -65,8 +65,6 @@ or
#include "/home/guillaume/.config/regolith/styles/gnome"
```
If you have staged your i3 config file, the application will not read it (for now) and any default value that you have changed will not be taken into account.
# Run It
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment