Skip to content

Commit 2de8754

Browse files
authored
Merge pull request #32 from mistalan/copilot/fix-readme-badges
Fix broken badges and enhance README presentation
2 parents 0ed7639 + 450949f commit 2de8754

1 file changed

Lines changed: 42 additions & 28 deletions

File tree

README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
1-
# Pixel's Refactory
1+
# 🏭 Pixel's Refactory
22
### _Automate Creativity._
33

4-
![Godot](https://img.shields.io/badge/Godot-4.5%20.NET-blue?logo=godot-engine&logoColor=white)
5-
![License](https://img.shields.io/badge/License-MIT-green)
6-
![Build](https://github.com/<user>/pixels-refactory/actions/workflows/ci.yml/badge.svg)
7-
![Export](https://github.com/<user>/pixels-refactory/actions/workflows/export.yml/badge.svg)
4+
[![Godot](https://img.shields.io/badge/Godot-4.5%20.NET-blue?logo=godot-engine&logoColor=white)](https://godotengine.org)
5+
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
6+
[![Build](https://github.com/mistalan/pixels-refactory/actions/workflows/ci.yml/badge.svg)](https://github.com/mistalan/pixels-refactory/actions/workflows/ci.yml)
7+
[![Export](https://github.com/mistalan/pixels-refactory/actions/workflows/export.yml/badge.svg)](https://github.com/mistalan/pixels-refactory/actions/workflows/export.yml)
88

99
---
1010

11-
## About the Game
11+
## 📚 Table of Contents
12+
- [ℹ️ About the Game](#ℹ️-about-the-game)
13+
- [✨ Features](#✨-features)
14+
- [🛠️ Tech Stack](#️-tech-stack)
15+
- [📁 Project Structure](#-project-structure)
16+
- [🚀 Build & Run](#-build--run)
17+
- [⚙️ Continuous Integration](#️-continuous-integration)
18+
- [📦 Creating a Release](#-creating-a-release)
19+
- [🤝 Contributing](#-contributing)
20+
- [📄 License](#-license)
21+
- [🗺️ Roadmap](#️-roadmap)
22+
23+
---
24+
25+
## ℹ️ About the Game
1226

1327
> Build, connect, and optimize the world's first creative factory.
1428
> Automate coding, testing and music production — but be careful:
@@ -25,17 +39,17 @@ refactor both code and reality.
2539

2640
---
2741

28-
## Features
29-
- Node-Graph Factory Editor — design event-driven production lines in an EPK-style flowchart
30-
- Tick-Based Simulation — deterministic throughput, latency, and quality metrics
31-
- Music Integration — code meets rhythm; automation becomes art
32-
- AI Research Tree — unlock Kusintel for smarter automation
33-
- Pixel Mini-Games — gain focus buffs and productivity boosts
34-
- Data-Driven JSON System — create your own nodes, edges and item types
42+
## Features
43+
- 🎨 **Node-Graph Factory Editor** — design event-driven production lines in an EPK-style flowchart
44+
- ⏱️ **Tick-Based Simulation** — deterministic throughput, latency, and quality metrics
45+
- 🎵 **Music Integration** — code meets rhythm; automation becomes art
46+
- 🤖 **AI Research Tree** — unlock Kusintel for smarter automation
47+
- 🎮 **Pixel Mini-Games** — gain focus buffs and productivity boosts
48+
- 📊 **Data-Driven JSON System** — create your own nodes, edges and item types
3549

3650
---
3751

38-
## Tech Stack
52+
## 🛠️ Tech Stack
3953
| Area | Technology |
4054
|------|-------------|
4155
| Engine | [Godot 4.5 .NET](https://godotengine.org) |
@@ -47,7 +61,7 @@ refactor both code and reality.
4761

4862
---
4963

50-
## Project Structure
64+
## 📁 Project Structure
5165

5266
```
5367
pixels-refactory/
@@ -77,38 +91,38 @@ pixels-refactory/
7791

7892
---
7993

80-
## Build & Run
94+
## 🚀 Build & Run
8195

82-
### Prerequisites
83-
- Godot 4.5 .NET (Mono)
84-
- .NET 9 SDK
96+
### 📋 Prerequisites
97+
- **Godot 4.5 .NET** (Mono) — [Download here](https://godotengine.org/download)
98+
- **.NET 9 SDK**[Download here](https://dotnet.microsoft.com/download)
8599

86-
### Build locally
100+
### 🔨 Build locally
87101
```bash
88102
godot --headless --build-solutions --quit
89103
dotnet restore
90104
dotnet build --configuration Release
91105
```
92106

93-
### Run in Editor
107+
### 🎮 Run in Editor
94108
Open `project.godot` in Godot → press ▶ to start the simulation.
95109

96-
### Optional: Headless smoke test
110+
### 🧪 Optional: Headless smoke test
97111
```bash
98112
godot --headless --quit
99113
```
100114

101115
---
102116

103-
## Continuous Integration
117+
## ⚙️ Continuous Integration
104118
| Workflow | Trigger | Purpose |
105119
|-----------|----------|----------|
106120
| ci.yml | Push / PR | Build validation |
107121
| export.yml | Tag (v*) | Windows & Linux exports |
108122

109123
---
110124

111-
## Creating a Release
125+
## 📦 Creating a Release
112126

113127
To create a new release and automatically build Windows/Linux exports:
114128

@@ -129,7 +143,7 @@ To create a new release and automatically build Windows/Linux exports:
129143

130144
---
131145

132-
## Contributing
146+
## 🤝 Contributing
133147
1. Fork the repo
134148
2. Create a feature branch
135149
3. Run `dotnet build`
@@ -139,14 +153,14 @@ All contributions must pass CI and follow `.github/copilot-instructions.md`.
139153

140154
---
141155

142-
## License
156+
## 📄 License
143157
**Code:** MIT
144158
**Assets:** CC BY-NC-SA 4.0
145159
Credit required, non-commercial use only for assets.
146160

147161
---
148162

149-
## Roadmap
163+
## 🗺️ Roadmap
150164
- [ ] Node editor MVP
151165
- [ ] JSON graph import/export
152166
- [ ] Tick simulation + KPIs
@@ -157,4 +171,4 @@ Credit required, non-commercial use only for assets.
157171
158172
---
159173

160-
"Every tick a beat. Every commit a note." — Pixel
174+
> _"Every tick a beat. Every commit a note."_**Pixel** 🕷️✨

0 commit comments

Comments
 (0)