docs: publishing README

This commit is contained in:
Alex Dunmow 2026-07-05 13:44:04 +08:00
parent daab6750fe
commit 11e10847bf

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Terminal
A command-line theme in phosphor green on near-black, with TTY window chrome and man-page article layouts. Monospace type runs throughout, and a paper-teletype light mode gives you an off-white, printer-ribbon alternative. It reads like a console a developer already trusts.
## Good for
We built Terminal for developer tools and open-source projects. Treat these as starting points, not limits. If the mood fits your project, use it:
- Dev tools and CLI utilities
- Open-source docs and changelogs
- Hacker and CTF communities
- Technical blogs and engineering handbooks
## What you get
- Five color presets, each with a tuned light mode and a tuned dark mode: Phosphor Green, Amber CRT, Paper TTY, Ice Terminal, and Magenta Hacker.
- JetBrains Mono and IBM Plex Mono, bundled and ready. Fonts stay admin-controlled, so you can swap them from the typography settings.
- Four persona blocks: a man-page section header, a code console, a keybind reference table, and a boot-log sequence.
- A typed-terminal hero that draws itself on a canvas at the top of the page. It respects reduced-motion and falls back to a static command block with JavaScript off.
- A demo site that installs when you activate the theme: a home page, an about page, a short blog, and a contact page whose form emails your admins.
- Every core block restyled to match, plus a themed login screen and a themed 404 page.
## Install
Install from the BlockNinja registry, then pick a preset and assign your fonts in the admin. Activate the demo content if you want a fully dressed starting point.