SickGaming/sg-website
1
0
Fork 0
Code Issues 5 Pull Requests Packages Projects 1 Releases Wiki Activity

Enhance README.md formatting for improved readability

Browse Source
This commit is contained in:
Aaron
2025-11-16 20:36:15 -05:00
parent ae0f7a123b
commit 3e113a4607
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -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. A minimal, easy-to-edit MyBB theme meant for quick tweaks and re-importing into the main site so others can contribute.
## Purpose ## Purpose
- Hold theme files (templates, CSS, images) in a repo so changes are versioned and reviewable. - 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. - Make it simple for contributors to propose UI changes and for maintainers to re-import.
## Repo structure (typical) ## Repo structure (typical)
- theme.xml — exported MyBB theme package (primary import/export artifact) - theme.xml — exported MyBB theme package (primary import/export artifact)
- templates/ — individual template files (one-per-template, editable) - templates/ — individual template files (one-per-template, editable)
- css/ — theme CSS (theme.css / theme.less / theme.scss) - 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 - README.md, LICENSE
## Quick edit & re-import ## Quick edit & re-import
Option A — Edit locally and import: Option A — Edit locally and import:
1. Clone repo: git clone <repo-url>
1. Clone repo: `git clone <repo-url>`
2. Edit templates/ or css/ and commit changes. 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. 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: Option B — Edit in MyBB Admin CP and export to repo:
1. Make template/CSS changes in Admin CP. 1. Make template/CSS changes in Admin CP.
2. Export the theme (Templates & Style → Export Theme) to get an updated theme.xml. 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. 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. Tip: Keep theme.xml as the canonical import artifact; include editable individual files for small edits and diffs.
## Contributing ## Contributing
- Fork → branch with a short name → open a PR describing the change and the visual effect. - 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. - Include screenshots or a link to a demo install when possible.
- Test changes on a local or staging MyBB instance before submitting. - Test changes on a local or staging MyBB instance before submitting.
## License & contact ## License & contact
- Add a LICENSE file (e.g., MIT) or state license in this README. - Add a LICENSE file (e.g., MIT) or state license in this README.
- Include maintainer contact or repo URL for questions. - Include maintainer contact or repo URL for questions.