Skip to main content

max / alloy_tui

2.6 KB · 34 lines History Blame Raw
1 # Project Alloy
2
3 *An opinionated tiling user layer for Fedora Silverblue.*
4
5 **Project Alloy is to Silverblue what Omarchy is to Arch:** a curated, beautifully-defaulted, keyboard-driven environment that fuses an immutable base, a Wayland tiling compositor, an opinionated app/tool stack, and a project-authored design system into one coherent system. An alloy is stronger than its component metals.
6
7 Short form for slugs, CLI binaries, package names, file extensions: `alloy`.
8
9 ## Status
10
11 Pre-v0. The docs are the project. Code follows.
12
13 ## License
14
15 GPLv3-or-later, with one exception: the `alloy_tui` crate is MIT, so other
16 projects can build terminal UIs on the design system without taking on
17 copyleft. See [`LICENSE`]LICENSE, [`crates/alloy_tui/LICENSE`]crates/alloy_tui/LICENSE,
18 and [`CONTRIBUTING.md`]CONTRIBUTING.md.
19
20 ## Docs
21
22 - [`docs/MANIFESTO.md`]docs/MANIFESTO.md — what Alloy is, who it's for, the thesis.
23 - [`docs/STACK.md`]docs/STACK.md — every pick (base, compositor, bar, lock, launcher, notifications, screenshot, file manager) with reasoning and what was rejected.
24 - [`docs/MARQUEE-APPS.md`]docs/MARQUEE-APPS.md — the egui design-system app pipeline.
25 - [`docs/COMPONENT-LIBRARY.md`]docs/COMPONENT-LIBRARY.md`alloy_tui` crate idioms and how themes reach the widgets.
26 - [`docs/RESEARCH-IMMEDIATE-MODE-DESIGN.md`]docs/RESEARCH-IMMEDIATE-MODE-DESIGN.md — late-term research sketch: what does Figma look like for immediate-mode UI? How do designers and engineers collaborate without designers writing Rust?
27 - [`docs/DESIGN-LANGUAGE.md`]docs/DESIGN-LANGUAGE.md — tinted-greyscale chrome, color reserved for information.
28 - [`docs/CONSOLE.md`]docs/CONSOLE.md — Alloy Console: the ratatui unified control surface (`alloy net`, `alloy audio`, `alloy mesh` shipped; `alloy config <path>` schema-driven editor next). Replaces the "graphical settings app" question.
29 - [`docs/CONTINUITY.md`]docs/CONTINUITY.md — a mesh VPN and file sync as base-image citizens: an Alloy install should be rejoinable, not just installable.
30 - [`docs/SHELL.md`]docs/SHELL.md — Nushell as the login shell; bash unchanged as `/bin/sh` and `/bin/bash`. Architecture, interop rules, accepted costs.
31 - [`docs/HARDWARE-FW12.md`]docs/HARDWARE-FW12.md — Framework Laptop 12 as the first hardware target: 2-in-1 stance, touch/tablet/rotation/OSK/fingerprint decisions.
32 - [`docs/IMAGE.md`]docs/IMAGE.md — Image composition: bootc + Containerfile, source on `git.sr.ht`, CI on `builds.sr.ht`, container image on `quay.io`.
33 - [`docs/todo.md`]docs/todo.md — open questions and next steps.
34