Write the project README #2

New issue

Open

opened 2026-08-07 18:56:05 +00:00 by OniiC · 0 comments

OniiC commented

2026-08-07 18:56:05 +00:00

Owner

Write a proper README when Onyrion has a clearer shape.

It should eventually explain:

why Onyrion exists
current project status and maturity stage
target audience and usability goals
group-first tiling model
high-level customization and preset philosophy
multi-repository component structure
relationship between core, shell, desktop and other components
development approach
supported/reference platform
how component compatibility and the final assembly repository work
AI usage principle

Current AI principle:

Architecture and implementation are intentionally developed by hand. AI may be used as a reference for small isolated questions, but not to generate the project or replace understanding.

Do not turn this issue into a blocker for development. Write the README when the project itself is mature enough for the document to describe reality rather than plans.

Write a proper README when Onyrion has a clearer shape. It should eventually explain: * why Onyrion exists * current project status and maturity stage * target audience and usability goals * group-first tiling model * high-level customization and preset philosophy * multi-repository component structure * relationship between core, shell, desktop and other components * development approach * supported/reference platform * how component compatibility and the final assembly repository work * AI usage principle Current AI principle: > Architecture and implementation are intentionally developed by hand. AI may be used as a reference for small isolated questions, but not to generate the project or replace understanding. Do not turn this issue into a blocker for development. Write the README when the project itself is mature enough for the document to describe reality rather than plans.