Update readme

This commit is contained in:
dece 2020-09-27 19:15:27 +02:00
parent 3225f0aac8
commit 40b9a61629

View file

@ -32,8 +32,9 @@ Features
- Export channel settings, filtering on user-provided root, to JSON files. - Export channel settings, filtering on user-provided root, to JSON files.
- Import channel settings from those JSON files. - Import channel settings from those JSON files.
- Imported settings are immediately applied to your session.
- Replace entire channel setting trees, or just update with provided values. - Replace entire channel setting trees, or just update with provided values.
- JSON files with predictable formatting for easy versioning. - JSON files have a predictable formatting for easy versioning.
@ -47,14 +48,14 @@ computers.
I got frustrated with the way Xfconf stored settings on disk: its XML files have I got frustrated with the way Xfconf stored settings on disk: its XML files have
unpredictable tag sorting and some volatile values, and Xfconf does not read unpredictable tag sorting and some volatile values, and Xfconf does not read
those settings unless you log back-in, and this is if you don't overwrite them those settings unless you log back in, and this is if you don't overwrite them
in the process. This makes diffing modifications cumbersome, especially when in the process. This makes diffing modifications cumbersome, especially when
trying to share parts of my settings in a Git repository. I needed a way to dump trying to share parts of my settings in a Git repository. I needed a way to dump
and restore only some parts of my settings. and restore only some parts of my settings.
Xfconf is the daemon storing and providing most Xfce configuration values, Xfconf is the daemon storing and providing most Xfce configuration values,
called properties. Sadly, it is not possible to manipulate these values without called properties. Sadly, it is not possible to manipulate these values without
building against libxfconf, which itself uses Glib, which I simply don't want building against libxfconf, which itself uses Glib, which I simply don't know
and don't want to use, either as a C program or using FFI. The lazy way is to and don't want to use, either as a C program or using FFI. The lazy way is to
use xion-query, a modified build of the xfconf-query CLI tool. use xion-query, a modified build of the xfconf-query CLI tool.
@ -71,9 +72,16 @@ Installation
### Get xion-query ### Get xion-query
Builds of xion-query will be available on my [Xfconf fork][xfconf-fork] soon, Go to my [Xfconf fork](https://github.com/Dece/xfconf/releases/) to get a build
but it already has building instructions (optional Docker build). or find instructions on how to build it.
If you want to build it manually, checkout the tags named "xion-<VERSION>". It
is possible to build xion-query with Docker if you don't want to mess around
finding the various dependencies.
Once you have your build, name it `xion-query`, make it executable and place it
somewhere in your path, e.g. in `/usr/local/bin/`.
### Get xion ### Get xion
Right now Xion is not packaged, just download the repo. Right now Xion is not packaged, just download the repo, this is on the todolist.