From 3e113a46078ea745479806d271dd3b2397094173 Mon Sep 17 00:00:00 2001 From: sickprodigy Date: Sun, 16 Nov 2025 20:36:15 -0500 Subject: [PATCH] Enhance README.md formatting for improved readability --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd7ab38..cbe1125 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,12 @@ A minimal, easy-to-edit MyBB theme meant for quick tweaks and re-importing into the main site so others can contribute. ## Purpose + - Hold theme files (templates, CSS, images) in a repo so changes are versioned and reviewable. - Make it simple for contributors to propose UI changes and for maintainers to re-import. ## Repo structure (typical) + - theme.xml — exported MyBB theme package (primary import/export artifact) - templates/ — individual template files (one-per-template, editable) - css/ — theme CSS (theme.css / theme.less / theme.scss) @@ -14,12 +16,15 @@ A minimal, easy-to-edit MyBB theme meant for quick tweaks and re-importing into - README.md, LICENSE ## Quick edit & re-import + Option A — Edit locally and import: -1. Clone repo: git clone + +1. Clone repo: `git clone ` 2. Edit templates/ or css/ and commit changes. 3. From MyBB Admin CP: Templates & Style → Import a Theme → upload theme.xml (or re-export from local build into theme.xml) and apply. Option B — Edit in MyBB Admin CP and export to repo: + 1. Make template/CSS changes in Admin CP. 2. Export the theme (Templates & Style → Export Theme) to get an updated theme.xml. 3. Add theme.xml (and any updated templates/css) to the repo and commit. @@ -27,11 +32,13 @@ Option B — Edit in MyBB Admin CP and export to repo: Tip: Keep theme.xml as the canonical import artifact; include editable individual files for small edits and diffs. ## Contributing + - Fork → branch with a short name → open a PR describing the change and the visual effect. - Include screenshots or a link to a demo install when possible. - Test changes on a local or staging MyBB instance before submitting. ## License & contact + - Add a LICENSE file (e.g., MIT) or state license in this README. - Include maintainer contact or repo URL for questions.