Inital commit
This commit is contained in:
commit
43b1143c75
18
CLAUDE.md
Normal file
18
CLAUDE.md
Normal file
@ -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 ...`)
|
||||
52
docs/yino-fsd.md
Normal file
52
docs/yino-fsd.md
Normal file
@ -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
|
||||
1
download/.keep
Normal file
1
download/.keep
Normal file
@ -0,0 +1 @@
|
||||
.keep
|
||||
Loading…
x
Reference in New Issue
Block a user