From 73391ded00c9423b4ffa0961b4ef3202489bbc8c Mon Sep 17 00:00:00 2001 From: Tony Bark Date: Sun, 27 Apr 2025 14:08:42 -0400 Subject: [PATCH] Rewrote README --- README.md | 43 +++++++++++++++++++++++++------------------ STATUS.md | 4 ++-- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 2b29b5a..6df3d6a 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,36 @@ Dress Up Zack is a port of my first (and only) Flash game series, ZC's Dress Up that was developed back in 2007. Both this and the originals are heavily inspired by The Sims 2: Body Shop in their own unique ways. -## 🗓️ Update Cycle +## 🏗️ Built With -| Type | Frequency | Notes | -| ------------ | -------------------- | ---------------------------------------- | -| Minor Update | Every 3–6 months | Small enhancements, non-breaking changes | -| Patch Update | Monthly or as needed | Bug fixes, security updates | -| Major Update | As needed | Engine upgrades, major refactors | +* [Godot Engine](https://godotengine.org/) (Baseline Version: Godot 4.4) +* Language: GDScript -## 🎮 Relaxation Practices +## 📅 Support Model (Experimental) -* 20% creative/recovery space built into development -* Mandatory cooldowns after major launches (minimum 1 week) -* Crisis Mode Activates if: - * Critical vulnerabilities - * Framework-breaking issue +| Patch Type | Timeline | +| -------------------------- | ---------------------------------------- | +| Critical Hotfixes | 1-2 weeks after discovery | +| Minor Bugfix Patches | Monthly or as needed | +| Content Updates | Every 6-12 months during Expansion Phase | +| Engine Compatibility Check | Every 6 months | -## 🛡️ Support +## 🛠️ Installation -* [x] Active Support -* [ ] Limited Support (Security patches only) -* [ ] Maintenance Mode (Dependency-only updates) -* [ ] Archived (No active work planned) +Instructions for installing or running the project locally: -## License +```shellscript +# Clone this repository +git clone https://github.com/tonytins/dressupzack.git + +# Open with Godot Engine +# (Adjust if additional setup needed) +``` + +## 🔍 Reporting Issues + +Found a bug or have feedback? Open an [Issue](https://github.com/tonytins/dressupzack/issues) and use the appropriate template. + +## 📜 License I license the source code of this game under both the [GNU General Public License, version 2.0](./LICENSE) or the [European Union Public License](./LICENSE_EUPL), ensuring it remains free to use, modify, and distribute under their terms. All assets, including the Flash games, are dedicated to the public domain under the [CC0 1.0 Universal Deed](./ASSET_LICENSE), allowing for unrestricted use, adaptation, and sharing. diff --git a/STATUS.md b/STATUS.md index d9b118e..5484a11 100644 --- a/STATUS.md +++ b/STATUS.md @@ -1,6 +1,6 @@ -# 📈 Project Status +# 📈 Project Status (Experimental) -This document tracks the current support phase of the project. This is a WIP and subject to change. +This document tracks the current support phase of the project. ## 🛠️ Current Status