Include a Complete README in Every Release Package

[lpmwfx]

📢 **Proposal to the Armory Team:

Include a Complete README in Every Release Package**

Dear Armory Team,

As Armory continues to evolve rapidly, especially across the 25.xx series, users are increasingly relying on downloadable ZIP releases rather than the live GitHub repository. However, these ZIP packages currently contain no version-specific documentation. This creates confusion when UI layouts, installation workflows, and feature locations change between versions.

Why a README inside each release is essential
1. The ZIP must be self-explanatory
Many users download Armory directly from the Releases page without browsing the wiki. If the UI has changed (as it has in recent versions), the ZIP does not explain those changes. A simple README would immediately clarify what to expect.
2. UIs evolve faster than online documentation
Tutorials and the wiki often show UI layouts from older versions. This leads users to believe something is broken when, in fact, the interface has simply been reorganized.
3. AI tools depend on local documentation
Increasing numbers of developers use AI assistants to help them install, configure, and debug Armory.
Without local documentation included in the package, AI assistants cannot reliably guide users through version-specific workflows.
4. Reduced support burden
A concise README inside the ZIP would prevent many repeated support questions such as:
• “Where is the Armory tab?”
• “Why doesn’t SDK installation match the wiki?”
• “Why is the Player panel moved?”
• “Why is the Setup window different from tutorials?”
5. Professional polish
Nearly all mature frameworks (Godot, Unreal, Unity extensions, Blender addons) include versioned README files in their distributions for clarity, offline usage, and archival stability.

⸻

Suggested contents for the README

A simple template would be enough:

Armory Version 25.09 (example)

Quick Installation:

1. Install via Blender → Preferences → Add-ons → Install
2. Enable Armory → Click “Update SDK”

UI Changes in this Version:

• Armory Tab removed from 3D Viewport side panel
• SDK installation moved inside Add-on settings
• Player settings relocated to Render Properties
• Trait Editor moved under Node Trees

Known Issues:

• (version-specific notes)

Documentation:
Link to wiki page matching this version

This small addition would dramatically increase usability, reduce confusion, and make Armory far easier to adopt—especially for new users and for those relying on AI-assisted workflows.

⸻

In short

Including a version-specific README in each release package would:
• Improve clarity
• Reduce user friction
• Ensure documentation matches the actual UI
• Make Armory more approachable
• Support AI-assisted development (which is becoming the norm)

Armory is an incredibly powerful tool. A simple README in each ZIP would make onboarding and version management far smoother for everyone.

Thank you for considering this improvement — it would make a significant positive impact on the user experience.

Regads
Lars Mathiasen
Denmark