summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-09 00:13:48 +1000
committer2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-09 00:13:48 +1000
commit88a3f09de553e11985f12ecaf40f334fad729ab9 (patch)
tree71d0a1ff00b54ed61e50cafcab8617173b8bc0ad /README.md
parentpaths: better to string (diff)
downloadcaelestia-shell-88a3f09de553e11985f12ecaf40f334fad729ab9.tar.gz
caelestia-shell-88a3f09de553e11985f12ecaf40f334fad729ab9.tar.bz2
caelestia-shell-88a3f09de553e11985f12ecaf40f334fad729ab9.zip
config: make appearance configurable
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5b43125..cb5fb45 100644
--- a/README.md
+++ b/README.md
@@ -147,10 +147,46 @@ git pull
All configuration options are in `~/.config/caelestia/shell.json`.
+> [!NOTE]
+> The example configuration only includes recommended configuration options. For more advanced customisation
+> such as modifying the size of individual items or changing constants in the code, there are some other
+> options which can be found in the source files in the `config` directory.
+
<details><summary>Example configuration</summary>
```json
{
+ "appearance": {
+ "anim": {
+ "durations": {
+ "scale": 1
+ }
+ },
+ "font": {
+ "family": {
+ "material": "Material Symbols Rounded",
+ "mono": "JetBrains Mono NF",
+ "sans": "IBM Plex Sans"
+ },
+ "size": {
+ "scale": 1
+ }
+ },
+ "padding": {
+ "scale": 1
+ },
+ "rounding": {
+ "scale": 1
+ },
+ "spacing": {
+ "scale": 1
+ },
+ "transparency": {
+ "enabled": false,
+ "base": 0.85,
+ "layers": 0.4
+ }
+ },
"general": {
"apps": {
"terminal": ["foot"],