commit 43b1143c752b14da8642b078ca97061e913903cb Author: Michael Smith Date: Sun Feb 15 22:06:12 2026 +0100 Inital commit diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..297808a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,18 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project + +Yino (a recursive acronym for "Yino Is Not Omarchy") is an opinionated set of configuration files for a desktop +operating system based on Debian Linux. It is exactly like Omarchy (https://github.com/basecamp/omarchy) but uses +Debian Linux as a stable base instead of Arch Linux. + +See `docs/yino-fsd.md` for the full functional specification and changelog. + +## Conventions + +- KISS principle applies +- Minimize dependencies, less is more; discuss with owner before adding any +- Never install global Python packages; use a venv in this repository when Python dependencies are needed (e.g. + `python3 -m venv venv && source venv/bin/activate && pip install ...`) diff --git a/docs/yino-fsd.md b/docs/yino-fsd.md new file mode 100644 index 0000000..1faec14 --- /dev/null +++ b/docs/yino-fsd.md @@ -0,0 +1,52 @@ +# Yino - Functional Specification Document + +## Document Information + +| Field | Value | +| :------ | :--------- | +| Version | 1.0 | +| Status | Draft | +| Created | 2026-02-15 | +| Updated | 2026-02-15 | + +## 1. Purpose + +This document specifies the functional requirements for Yino (a recursive acronym for "Yino Is Not Omarchy") an +opinionated set of configuration files for a desktop operating system based on Debian Linux. It is exactly like +[Omarchy](https://github.com/basecamp/omarchy) but uses [Debian Linux](https://www.debian.org/) as a stable base +instead of Arch Linux. + +## 2. Goals + +- Produce a feature complete copy of Omarchy based on Debian Linux instead of Arch Linux +- Replace all Arch specific tooling with Debian compatible counterparts where necessary / required +- Remove anything that can be removed that has been added to Omarchy in order to deal with its possibly unstable, + rolling release base of Arch Linux +- Just like Omarchy, produce an ISO image that can perform a complete offline installation of Yino + +## 3. Architecture + +This should match Omarchy's architecture + +- Debian Linux as a base +- Btrfs filesystem +- Full disk encryption +- Single user automatic sign in: encrypted disk unlock authenticates user, no further authentication is required + except for unlocking the session and super user commands (sudo) +- Wayland only +- Latest Hyprland version as compositor and desktop environment +- Target architecture is amd64, reference hardware will be Framework 13 AMD Ryzen™ 7040 laptop + +## 4. Design principles + +- Version control (git) must be used +- Less is more, minimize dependencies, avoid pulling in extra dependencies, always talk through with owner first +- Keep it simple, KISS principle applies +- Keep a changelog in this functional specification document + +## 5. Development environment + +- QEMU should be used for testing and demo virtual machines +- Keep a cache of downloaded assets (e.g. Debian installation ISO) in this repository's `download` directory + +## 6. Changelog diff --git a/download/.keep b/download/.keep new file mode 100644 index 0000000..5e40119 --- /dev/null +++ b/download/.keep @@ -0,0 +1 @@ +.keep