diff --git a/INSTALL.md b/INSTALL.md index 3dca1fd..112307b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,8 @@ # Apex Theme System: Installation Guide -This guide explains how to install the **Apex Neon** (Dark) and **Apex Aeon** (Light) themes for various applications. All generated theme files can be found in the `dist/` directory after running the build script. +This guide explains how to install the **Apex Neon** (Dark) and **Apex Aeon** (Light) themes. + +All generated theme files can be found in the `dist/` directory after running `uv run build.py`. --- @@ -81,17 +83,16 @@ This guide explains how to install the **Apex Neon** (Dark) and **Apex Aeon** (L --- -## 5. Zed Editor (Local Dev) +## 5. Zed Editor **Files:** -- `dist/zed/apex.json` (Contains both Neon and Aeon variants) +- `dist/zed/apex.json` (Aggregated: contains **both** Neon and Aeon) **Installation:** -Zed loads local extensions from the `extensions` folder, but for simple theme development, you can open the theme file directly in Zed or follow Zed's [extension development guide](https://zed.dev/docs/extensions/developing-extensions). - -For local usage: -1. Ensure the `apex.json` is formatted as a proper extension if you plan to publish it. -2. Currently, this file is a raw theme definition. You may need to wrap it in a Zed extension structure to load it permanently via the extensions menu. +1. Open Zed. +2. Go to **Extensions** (Ctrl+Shift+X). +3. If developing locally, you can open this file as a Dev Extension. +4. Once loaded, switch themes via the theme picker (Ctrl+K Ctrl+T) and select "Apex Neon" or "Apex Aeon". --- @@ -112,3 +113,21 @@ For local usage: } } ``` + +--- + +## 7. GTK4 / Libadwaita + +**Files:** +- `dist/gtk4/gtk.css` (Aggregated: Responsive to System Dark/Light mode) + +**Installation:** +1. This file maps Apex colors to Libadwaita named colors (`@window_bg_color`, etc.). +2. Copy or symlink it to your GTK4 config directory: + + ```bash + # For standard GTK4 apps + mkdir -p ~/.config/gtk-4.0 + ln -s $(pwd)/dist/gtk4/gtk.css ~/.config/gtk-4.0/gtk.css + ``` +3. To apply changes immediately, you may need to restart your applications or log out/in. \ No newline at end of file diff --git a/README.md b/README.md index 82b9765..2eba341 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,18 @@ The system consists of two primary canvases: - **Apex Neon**: A high-contrast dark theme for low-light focus. - **Apex Aeon**: A clinical, high-clarity light theme for daylight precision. +## Supported Platforms + +The factory currently generates native themes for: + +- **Neovim** (Lua) +- **Zed** (JSON extension) +- **Alacritty** (TOML) +- **Kitty** (Conf) +- **Zsh** (Theme with Radar/AAR) +- **Gemini CLI** (JSON) +- **GTK4 / Libadwaita** (CSS) + ## The Apex DNA Apex is built on a unified semantic discipline where every color has a specific role: @@ -17,13 +29,31 @@ Apex is built on a unified semantic discipline where every color has a specific - **Purple is Sacred**: Reserved for root access, special modes, or exceptional system states. - **Contrast is King**: Non-negotiable rules for readability (e.g., Black text on Red backgrounds). +## Development & Building + +This project uses a custom build engine written in Python with Jinja2 templates. + +### Prerequisites +- [uv](https://github.com/astral-sh/uv) (Recommended for dependency management) +- Python 3.12+ + +### Build +To regenerate all theme files from the source DNA (`src/*.yaml`): + +```bash +uv run build.py +``` + +Artifacts are output to the `dist/` directory, organized by application. + ## Project Structure - `src/`: Source YAML definitions containing the "DNA" of the themes. -- `templates/`: Jinja2 templates for generating configuration files for various tools (Alacritty, Neovim, Zed, etc.). +- `templates/`: Jinja2 templates for each supported application. - `dist/`: Compiled theme files ready for deployment. -- `apex-neon.md` / `apex-aeon.md`: Detailed specifications for each theme. +- `GEMINI.md`: AI Context & Source of Truth. +- `apex-neon.md` / `apex-aeon.md`: Detailed specifications. ## Authors -- **S0wlz (Owlibou)** +- **S0wlz (Owlibou)** \ No newline at end of file