From 78b10cfdba97914602bbc086f8c8cf25d1733b8b Mon Sep 17 00:00:00 2001 From: sickprodigy Date: Tue, 11 Nov 2025 18:38:15 -0500 Subject: [PATCH] Add README.md for Sick Gaming Website Theme with setup and contribution guidelines --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fd7ab38 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Sick Gaming Website Theme (MyBB theme) + +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) +- images/ — theme images and icons +- README.md, LICENSE + +## Quick edit & re-import +Option A — Edit locally and import: +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. + +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. + +Keep this README updated with any project-specific import steps or tooling.