From 1857404c9d6ff293b46f6043fa0ee12d39f078a5 Mon Sep 17 00:00:00 2001 From: Jordan Harrison Date: Mon, 21 Sep 2026 08:38:36 +0100 Subject: [PATCH] docs(readme): align GitHub overview with Meith branding --- README.md | 98 +++++++++++++++++++++++------- apps/web/public/wordmark-dark.svg | 13 ++++ apps/web/public/wordmark-light.svg | 13 ++++ docs/contributing/brand.md | 13 ++++ 4 files changed, 115 insertions(+), 22 deletions(-) create mode 100644 apps/web/public/wordmark-dark.svg create mode 100644 apps/web/public/wordmark-light.svg diff --git a/README.md b/README.md index c58e3cac..44bba13d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,29 @@ -# Meith +

+ + + + Meith + +

-Open-source forum software for communities that want to run their own board. -Meith includes discussions, search, moderation, themes, and plugins, with most -reading and posting available without JavaScript. +**Open-source, self-hosted forum software.** -[Website](https://www.meith.dev) · [Community](https://forum.meith.dev) · -[Documentation](./docs/README.md) · [Issues](https://github.com/meith-dev/meith/issues) +Meith gives your community a board on your domain, with a PostgreSQL database +you control. Discussions, search, moderation, themes and plugins are included. +Most reading and posting works with JavaScript switched off. + +[Get started ↗](./docs/start/quickstart.md) · +[Documentation ↗](./docs/README.md) · +[meith.dev ↗](https://www.meith.dev) · +[Community ↗](https://forum.meith.dev) + + + + + A Meith board in the Default theme, with forums grouped by purpose and the latest threads and posts alongside them. + + +The Default theme on a desktop, using sample data. Images follow your light or dark scheme. ## Try it locally @@ -18,18 +36,55 @@ npm install npm run dev ``` -Open . This preview uses sample data and needs no -database or Docker. Saving posts requires PostgreSQL; the -[quickstart](./docs/start/quickstart.md) explains the next step. +Open . The preview uses sample data, with no database or +Docker required. It does not save posts or create accounts. To start writing, +[connect a local PostgreSQL database](./docs/operations/local-board.md). + +## What’s included + +- **Discussions and search.** Forums, threads, polls, attachments and full-text + search, with results limited to content each member can access. +- **Moderation.** Content approval, reports, warnings and bans, with permissions + for the people looking after each forum. +- **Themes and plugins.** Change the board’s appearance or add features through + documented extension points. Themes support light and dark schemes. +- **Member tools.** Profiles, private messages, notifications and subscriptions + to threads and forums. +- **Operations.** An operator CLI for backups, restores, imports and upgrades. + Bring an existing community across from MyBB or phpBB. + +
+ See a thread on a phone + +

The same board in the Default theme, with posts in the order they were written.

+ + + + + A Meith thread on a phone: members share what they are reading, with each post’s author, date and position in the thread. + + +
+ +## Run a board + +Meith is [MIT licensed](./LICENSE.md), with no licence fee or per-member pricing. +You arrange the domain and hosting. A live board needs PostgreSQL, persistent +upload storage, email delivery and scheduled tasks. + +[Choose a deployment](./docs/operations/deployment.md) using Coolify, Docker +Compose or Vercel, then follow the +[community setup checklist](./docs/administration/first-steps.md). The +[operations guide](./docs/operations/operating.md) covers ongoing maintenance. -## Run a community +Moving from MyBB or phpBB? Read the [migration guide](./docs/operations/migrating.md) +for supported data, limitations and a rehearsal before cutover. -[Choose a deployment](./docs/operations/deployment.md): Coolify, -Docker Compose, or Vercel. After installation, -[set up your community](./docs/administration/first-steps.md). +## Make it yours -Already running MyBB or phpBB? Start with the -[migration guide](./docs/operations/migrating.md). +Start with [theme development](./docs/extensions/themes.md) or +[write your first plugin](./docs/extensions/first-plugin.md). To connect another +application, use the [API quickstart](./docs/integrations/api-quickstart.md). ## Contribute @@ -42,14 +97,13 @@ pnpm install pnpm dev ``` -The forum opens at with sample data. Read -[Development](./docs/contributing/development.md) for the workspace layout, -database setup, tests, and contribution workflow. Follow [AGENTS.md](./AGENTS.md) -and run `pnpm verify` and `pnpm comments:check` before submitting a pull request. +The board opens at with sample data. The +[development guide](./docs/contributing/development.md) covers database setup, +the workspace and tests. Follow [AGENTS.md](./AGENTS.md) and run `pnpm verify` +and `pnpm comments:check` before submitting a pull request. -To build an extension for your own board, start with -[Write your first plugin](./docs/extensions/first-plugin.md) or -[Theme development](./docs/extensions/themes.md). +[Report a problem](https://github.com/meith-dev/meith/issues) or join the +[community board](https://forum.meith.dev) to discuss a change. ## Licence diff --git a/apps/web/public/wordmark-dark.svg b/apps/web/public/wordmark-dark.svg new file mode 100644 index 00000000..036c26e4 --- /dev/null +++ b/apps/web/public/wordmark-dark.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + meith + diff --git a/apps/web/public/wordmark-light.svg b/apps/web/public/wordmark-light.svg new file mode 100644 index 00000000..fb6b5423 --- /dev/null +++ b/apps/web/public/wordmark-light.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + meith + diff --git a/docs/contributing/brand.md b/docs/contributing/brand.md index 3f8cb7ce..d1f64e50 100644 --- a/docs/contributing/brand.md +++ b/docs/contributing/brand.md @@ -16,6 +16,13 @@ The mark uses the current accent; its threads use accent-contrast. Static icons | Minimum | 16px mark alone; 20px mark in a lockup | | Social-card exception | `Meith`, weight 600 | +The GitHub README uses `apps/web/public/wordmark-light.svg` and +`apps/web/public/wordmark-dark.svg`. These transparent lockups reuse the mark, +proportions and scheme colours above, with half a mark’s height of clear space. +Keep them in step with the site logo. Use a native `picture` element with +`prefers-color-scheme` sources and a light fallback so the wordmark remains +legible in both GitHub schemes. + ## Colour | Token | Light | Dark | Theme token | @@ -67,6 +74,12 @@ Use actual product captures with fixture data, descriptive alt text and paired l Exclude browser chrome, device mockups, stock/generated imagery, mascots and decorative icons. Use a flat screenshot with a border. Diagrams use the brand tokens. +The GitHub README reuses the Default desktop and mobile thread pairs from +`apps/web/public/shots`, with `picture` elements selecting the scheme and +descriptive alt text on each fallback image. Keep the desktop overview visible; +put the phone capture in a native disclosure to keep the setup instructions +easy to reach. Refresh these captures with `pnpm site:shots`. + ## Homepage and live preview The homepage introduces Meith as open-source, self-hosted forum software, then explains conversations, moderation, ownership, extensions and deployment. The hero is a simple editorial composition: one large mixed sans/serif headline, a fine dividing rule, a clear introduction on the left and the setup/demo actions on the right. Whitespace and typography establish the hierarchy. The actions stack below the introduction on phones. Keep the opening editorial; the compact, two-forum live preview sits below the left-hand “Make it yours” heading, with extension guides in the right column. The columns stack on phones. The technology section explains the role of each part of the stack alongside major versions read from the repository. Versions use slightly larger, medium-weight accent mono numerals beside the technology name. Keep hosting costs distinct from Meith’s lack of licence and per-member fees. The local scaffold uses sample data. The closing setup note explicitly distinguishes that local preview from arranging a domain, hosting and PostgreSQL for a live board, and links to deployment and ongoing operation instructions.