Skip to content

Commit ffc681a

Browse files
committed
Update README with clear vision and discussion methods
1 parent 22802b3 commit ffc681a

File tree

2 files changed

+44
-8
lines changed

2 files changed

+44
-8
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,17 @@ Click on image to play video:
5757

5858
## Vision
5959

60-
The vision for the Untold Engine is to continually shape a 3D engine that balances clarity, performance, and creativity.
60+
The Untold Engine strives to be a **stable, performant, and developer-friendly** 3D engine that empowers creativity, removes friction, and makes game development feel effortless for Apple developers
6161

62-
- **Clarity** → to keep the codebase and API straightforward and readable, making the engine a resource for both building and learning.
63-
- **Performance** → to push the limits of Apple devices with a modern Metal renderer, while staying lean and efficient.
64-
- **Creativity** → to provide a flexible foundation where developers can experiment freely and bring ideas to life.
62+
## Guiding Principles
6563

66-
This vision guides the project forward: Untold Engine will always evolve, but its purpose remains the same — to make game creation both powerful and accessible.
64+
To achieve this vision, we follow these principles:
65+
66+
- The engine strives to remain stable and crash-free.
67+
- The codebase is backed by unit tests.
68+
- We profile continuously to prevent regressions (visual and performance).
69+
- The API must remain clear and user-friendly.
70+
- We always think about the developer first—removing friction so they can focus on their games.
6771

6872

6973
### Current Features:
@@ -292,4 +296,13 @@ This project is licensed under the **LGPL v2.1**.
292296
For more details, see the full license text [here](https://www.gnu.org/licenses/lgpl-2.1.html).
293297

294298
---
299+
300+
## Questions & Discussions
301+
302+
To keep communication clear and accessible for everyone:
303+
304+
- 💡 Use **[GitHub Discussions](https://github.com/untoldengine/UntoldEngine/discussions)** for feature proposals, ideas, or general questions.
305+
- 🐞 Use **[GitHub Issues](https://github.com/untoldengine/UntoldEngine/issues)** for bugs or concrete tasks that need tracking.
306+
307+
This way, conversations stay organized, visible to the community, and future contributors can benefit from past discussions.
295308

docs/ContributionGuidelines.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,27 @@
22

33
Thank you for your interest in contributing!
44

5-
The vision for Untold Engine is to continually shape a 3D engine that balances **clarity, performance, and creativity**.
5+
The vision for Untold Engine is to continually shape a 3D engine that is **stable, performant and developer-friendly**.
66
As maintainer, my focus is on **performance, testing, quality control, and API design**.
77
Contributors are encouraged to expand features, fix bugs, improve documentation, and enhance usability — always keeping the vision in mind.
88

99
---
1010

1111
## Maintainer Responsibilities
1212

13-
The Untold Engine is guided by a clear vision: **clarity, performance, and creativity**.
14-
As the maintainer, my primary focus is to ensure the project stays true to this vision while remaining stable, performant, and approachable.
13+
The Untold Engine is guided by a clear vision: To be a stable, performant, and developer-friendly 3D engine that empowers creativity, removes friction, and makes game development feel effortless.
14+
15+
## Guiding Principles
16+
17+
To achieve this vision, we follow these principles:
18+
19+
- The engine strives to remain stable and crash-free.
20+
- The codebase is backed by unit tests.
21+
- We profile continuously to prevent regressions (visual and performance).
22+
- The API must remain clear and user-friendly.
23+
- We always think about the developer first—removing friction so they can focus on their games.
24+
25+
As the maintainer, my primary focus is to ensure the project stays true to this vision.
1526

1627
### What I Focus On
1728
- **Performance** → keeping the renderer and systems lean, efficient, and optimized for Apple hardware.
@@ -104,4 +115,16 @@ Your guide must follow this structure:
104115
- Make sure your code follows the [formatting guidelines](Formatting.md).
105116

106117
---
118+
119+
## Questions & Discussions
120+
121+
To keep communication clear and accessible for everyone:
122+
123+
- 💡 Use **[GitHub Discussions](https://github.com/untoldengine/UntoldEngine/discussions)** for feature proposals, ideas, or general questions.
124+
- 🐞 Use **[GitHub Issues](https://github.com/untoldengine/UntoldEngine/issues)** for bugs or concrete tasks that need tracking.
125+
126+
This way, conversations stay organized, visible to the community, and future contributors can benefit from past discussions.
127+
128+
---
129+
107130
Thank you for contributing to the Untold Engine! Following these guidelines will ensure that your work aligns with the project's goals and provides value to users.

0 commit comments

Comments
 (0)