Files
apex/INSTALL.md
s0wlz (Matthias Puchstein) 2eea11c22f docs: refactor documentation for completeness and accuracy
- Updated README.md with full list of 7 supported platforms and build instructions.
- Updated INSTALL.md to include GTK4 instructions and clarify Zed/GTK aggregated files.
- Added 'Building' section to README.
2025-12-31 00:40:41 +01:00

3.0 KiB

Apex Theme System: Installation Guide

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.


1. Neovim (nvim)

Files:

  • dist/nvim/colors/apex-neon.lua
  • dist/nvim/colors/apex-aeon.lua

Manual Installation:

  1. Copy the files to your Neovim colors directory:
    mkdir -p ~/.config/nvim/colors
    cp dist/nvim/colors/*.lua ~/.config/nvim/colors/
    
  2. Enable the theme in your init.lua:
    vim.cmd.colorscheme "apex-neon"
    -- or
    vim.cmd.colorscheme "apex-aeon"
    

2. Zsh

Files:

  • dist/zsh/apex-neon.zsh-theme
  • dist/zsh/apex-aeon.zsh-theme

Installation:

  1. Source the desired theme file in your .zshrc.

  2. Ideally, place the file in a standard location like ~/.zsh/themes/.

    # In ~/.zshrc
    source /path/to/apex-neon.zsh-theme
    

3. Kitty Terminal

Files:

  • dist/kitty/apex-neon.conf
  • dist/kitty/apex-aeon.conf

Installation:

  1. Copy the files to your Kitty config directory:
    cp dist/kitty/*.conf ~/.config/kitty/
    
  2. Include one of them in your ~/.config/kitty/kitty.conf:
    include apex-neon.conf
    # include apex-aeon.conf
    

4. Alacritty

Files:

  • dist/alacritty/apex-neon.toml
  • dist/alacritty/apex-aeon.toml

Installation:

  1. Copy the files to your Alacritty config directory:
    mkdir -p ~/.config/alacritty/themes
    cp dist/alacritty/*.toml ~/.config/alacritty/themes/
    
  2. Import the theme in your ~/.config/alacritty/alacritty.toml:
    [general]
    import = ["~/.config/alacritty/themes/apex-neon.toml"]
    

5. Zed Editor

Files:

  • dist/zed/apex.json (Aggregated: contains both Neon and Aeon)

Installation:

  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".

6. Gemini CLI

Files:

  • dist/gemini/apex-neon.json
  • dist/gemini/apex-aeon.json

Installation:

  1. Edit your Gemini settings file (usually ~/.config/gemini/settings.json or via gemini settings).

  2. Point the theme property to the absolute path of the generated file:

    {
      "ui": {
        "theme": "/absolute/path/to/dist/gemini/apex-neon.json"
      }
    }
    

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:

    # 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.