themes

---

Design themes (GRUB, GTK, vscode-workspace, e.a.)

---

Note: This repository is part of the design-tools monorepo.
📚 View full documentation →

---

📋 Table of Contents

• Overview
• Features
• Installation
• Usage
• Configuration
• Documentation
• Contributing
• Roadmap
• Support
• Licence
• Acknowledgements

---

🔍 Overview

Design themes (GRUB, GTK, vscode-workspace, e.a.)

Why themes?

The themes project centralises desktop and editor theming assets so visual design can be shared, versioned, and reused across environments.

---

✨ Features

• 🚀 GTK Themes - README
• 🔧 GNOME Shell Styling - Coordinated shell CSS and asset variants
• 📦 Packaged Variants - Static and animated theme flavours
• 🔒 Readable Contrast Choices - Colour sets tuned for practical usability
• ⚡ Monorepo Integration - Versioned alongside design-flows

---

📥 Installation

Prerequisites

• GNOME Shell with user-theme extension (for shell themes)
• GTK 4-capable desktop applications
• gsettings available for shell theme switching

Quick Start

# Clone the repository
git clone https://github.com/XAOSTECH/themes.git
cd themes

# Run installation
./install.sh

# Or manual installation
cp -r GTK/* ~/.themes/
gsettings set org.gnome.desktop.interface gtk-theme "NeonPink"

Package Managers

# npm
echo "No npm package is published for this repository"

# yarn
echo "No yarn package is published for this repository"

# apt (Debian/Ubuntu)
echo "Install by cloning the repository and copying theme assets"

# brew (macOS)
echo "Homebrew package not available"

---

🚀 Usage

Basic Usage

cd GTK
ls

Advanced Usage

gsettings set org.gnome.shell.extensions.user-theme name "NeonPink"
gsettings set org.gnome.desktop.interface gtk-theme "NeonPink"

Examples

📘 Example 1: Activate Static Theme

gsettings set org.gnome.shell.extensions.user-theme name "NeonPink"
gsettings set org.gnome.desktop.interface gtk-theme "NeonPink"

📗 Example 2: Activate Animated Variant

gsettings set org.gnome.shell.extensions.user-theme name "NeonPink_Animated"

---

⚙️ Configuration

Environment Variables

Variable	Description	Default
XDG_CONFIG_HOME	User configuration root used by desktop components	~/.config
XDG_DATA_HOME	User data root that may contain theme assets	~/.local/share

Configuration File

# config.yml
theme:
  shell: NeonPink
  gtk: NeonPink
  variant: static

---

📚 Documentation

Document	Description
📖 Getting Started	Quick start guide
📋 API Reference	Complete API documentation
🔧 Configuration	Configuration options
❓ FAQ	Frequently asked questions

---

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting PRs.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See also: Code of Conduct | Security Policy

---

🗺️ Roadmap

• NeonPink static GNOME Shell + GTK variant
• NeonPink animated GNOME Shell variant
• Add additional colourway variants
• Add installer script hardening and validation
• Add screenshots and preview gallery automation

See the open issues for a full list of proposed features and known issues.

---

💬 Support

• 📧 Email: maintainers@xaostech.dev
• 💻 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📝 Wiki: GitHub Wiki

---

📄 Licence

Distributed under the GPL-3.0 License. See LICENSE for more information.

---

🙏 Acknowledgements

• GNOME Shell and GTK theming communities
• pastel for colour exploration
• XAOSTECH contributors and testers

---

⬆️ Back to Top