Commit fe487165 authored by Guillaume Deflaux's avatar Guillaume Deflaux
Browse files

Simplified readme.

parent 364d4b8b
# Regolith On Stage
A GTK application that allows you to configure Regolith Linux without having to edit the config files manually.
Regolith On Stage is a GTK application that allows you to simply and safely override Xresources without needing to manually edit the configuration files. Customized Xresources will be written to the `~/.config/regolith/Xresources` file. This is the only file that Regolith On Stage will modify/write.
The application parses the system default files in order to extract all the Xresources variables. The parse sequence is as follows:
Regolith On Stage parses all system or user configuration files so it is safe to use on staged systems, i.e. any already customized Xresource will be kept.
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. If you are already using `~/.config/regolith/Xresources` and/or `~/.Xresources-regolith` to override variables your custom definitions will be kept.
## Feature Overviews
The application will write all the custom definitions to `~/.config/regolith/Xresources` (the file is generated by the application).
- Overrides Xresources without manually editing configuration files.
- Works on staged systems
- Search through and sort Xresources
- Handles macros (`#define`) defined in Look files
- Ability to restore Xresource to default values
- Generates and writes `~/.config/Xresources` files automatically
- Displays icons from i3bar icon font
- Reloads environment on demand
## Preview
![screenshot](https://gitlab.com/gdeflaux/regolith-on-stage/-/raw/master/screenshot.png)
## Compile It
The application is written in [Vala](https://wiki.gnome.org/Projects/Vala) and is build with [Meson](https://mesonbuild.com/).
## Documentation
Dependencies (all standard for a GTK app):
### Compile & Run
- glib-2.0
- gtk+-3.0
- gee-0.8
- gio-2.0
The application is written in [Vala](https://wiki.gnome.org/Projects/Vala) and is built with [Meson](https://mesonbuild.com/).
```
$ git clone https://gitlab.com/gdeflaux/regolith-on-stage.git
......@@ -34,41 +31,27 @@ $ cd regolith-on-stage
$ meson build
$ cd build
$ ninja
$ ./regolith-on-stage
```
## Requirements
If you want to install the application run `meson install` from the `build` directory.
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:
### Configuration Files Loading Sequence
```
#include "/etc/regolith/styles/cahuella/root"
```
Regolith On Stage will populate its list of Xresources by parsing the following files (in order):
or
1. `~/.Xresources-regolith` or `/etc/regolith/styles/root` (In that order. First one found is used)
```
! -- Styles - Colors
#include "/etc/regolith/styles/cahuella/color"
! -- Styles - Fonts
#include "/etc/regolith/styles/cahuella/typeface"
! -- Styles - Theme
#include "/etc/regolith/styles/cahuella/theme"
! -- Applications
! These files map values defined above into specific app settings.
#include "/home/guillaume/.config/regolith/styles/st-term"
#include "/home/guillaume/.config/regolith/styles/i3-wm"
#include "/home/guillaume/.config/regolith/styles/i3xrocks"
#include "/home/guillaume/.config/regolith/styles/rofi"
#include "/home/guillaume/.config/regolith/styles/gnome"
```
If you have staged your configuration file `~/.Xresources-regolith` is loaded, otherwise the default system file `/etc/regolith/styles/root` is loaded. The value of all Xresources defined from this file will be considered default values.
# Run It
2. `~/.config/regolith/i3/config` or `/etc/regolith/i3/config` (In that order. First one found is used)
```
$ cd regolith-on-stage
$ cd build
$ ./com.gitlab.gdeflaux.regolith-on-stage
```
If you have staged your i3 configuration file `~/.config/regolith/i3/config` is loaded, otherwise the default system file `/etc/regolith/i3/config` is loaded. The i3 configuration file is parsed in order to extract any Xresource used by i3 that might not be defined in previously parsed files.
3. `/usr/share/i3xrocks/*`
Each script is parsed in order to extract any Xresource used in the scripts that might not be defined in previously parsed files.
4. `~/.config/regolith/Xresources`
Loads the standard Xresource user override file `~/.config/regolith/Xresources` and updates the value of previously loaded Xresources. This is the only file that Regolith On Stage will write/modify.
......@@ -6,5 +6,5 @@ Terminal=false
Type=Application
Categories=Utility;
Comment=Configure Regolith With Ease
Icon=application-vnd.oasis.opendocument.chart
Icon=applications-other
Keywords=configuration;settings;
......@@ -26,4 +26,4 @@ gresources = gnome.compile_resources(
source_dir: 'data'
)
executable('regolith-on-stage', [ sources, gresources ], dependencies: dependencies)
executable('regolith-on-stage', [ sources, gresources ], dependencies: dependencies, install: true)
screenshot.png

155 KB | W: | H:

screenshot.png

189 KB | W: | H:

screenshot.png
screenshot.png
screenshot.png
screenshot.png
  • 2-up
  • Swipe
  • Onion skin
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