From 2344e99e8937edcb5d7f00fa6364b83e1f0956c6 Mon Sep 17 00:00:00 2001 From: "s0wlz (Matthias Puchstein)" Date: Tue, 30 Dec 2025 07:02:42 +0100 Subject: [PATCH] docs: add installation instructions for all supported apps --- INSTALL.md | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..3dca1fd --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,114 @@ +# 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. + +--- + +## 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: + ```bash + mkdir -p ~/.config/nvim/colors + cp dist/nvim/colors/*.lua ~/.config/nvim/colors/ + ``` +2. Enable the theme in your `init.lua`: + ```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/`. + + ```bash + # 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: + ```bash + cp dist/kitty/*.conf ~/.config/kitty/ + ``` +2. Include one of them in your `~/.config/kitty/kitty.conf`: + ```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: + ```bash + mkdir -p ~/.config/alacritty/themes + cp dist/alacritty/*.toml ~/.config/alacritty/themes/ + ``` +2. Import the theme in your `~/.config/alacritty/alacritty.toml`: + ```toml + [general] + import = ["~/.config/alacritty/themes/apex-neon.toml"] + ``` + +--- + +## 5. Zed Editor (Local Dev) + +**Files:** +- `dist/zed/apex.json` (Contains both Neon and Aeon variants) + +**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. + +--- + +## 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: + + ```json + { + "ui": { + "theme": "/absolute/path/to/dist/gemini/apex-neon.json" + } + } + ```