Skip to content

Commit 024f64f

Browse files
authored
Revise README for clarity and structure
Updated README to enhance clarity and structure, including new sections and improved formatting.
1 parent 69a1588 commit 024f64f

1 file changed

Lines changed: 102 additions & 40 deletions

File tree

README.md

Lines changed: 102 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,153 @@
1-
# 🎨 Issue-Ink
1+
# 🎨 Issue-Ink
22
## 🌍 The Global Rorschach Canvas
3-
A slow-motion collaborative art experiment powered entirely by GitHub.
4-
No servers. No database. Just Issues → Actions → SVG.
3+
4+
A collaborative pixel canvas powered entirely by **GitHub Issues + GitHub Actions**.
5+
6+
No backend.
7+
No database.
8+
Just commits.
59

610
---
711

812
## 🖼 Live Canvas
913

10-
![Canvas](map.svg)
14+
![Canvas](map.svg?ts=0)
1115

1216
---
1317

14-
## 🎨 How To Paint
15-
1. Go to the **Issues** tab.
16-
2. Click **New Issue**.
17-
3. Use this exact format in the **title**:
18+
## ✍️ Paint a Pixel
19+
20+
Anyone can contribute.
21+
22+
1. Go to the **Issues** tab
23+
2. Click **New Issue**
24+
3. Use this exact format as the **title**:
1825

1926
```
2027
Paint [A5] #FF5733
2128
```
2229

23-
That’s it.
24-
If valid, your pixel will be painted automatically.
30+
Submit — and your pixel is painted automatically.
2531

2632
---
2733

28-
## 📏 Valid Coordinates
34+
## ⚡ What Happens Next?
35+
36+
When you open an issue:
37+
38+
1. The title is parsed
39+
2. A GitHub Action validates your input
40+
3. The SVG canvas (`map.svg`) is updated
41+
4. Game state is stored in `data/state.json`
42+
5. Changes are committed
43+
6. The canvas refreshes in this README
44+
45+
Everything happens in public.
46+
47+
---
2948

30-
Rows: **A–H**
31-
Columns: **1–8**
49+
## 📏 Canvas Coordinates
50+
51+
- Rows: **A–H**
52+
- Columns: **1–8**
3253

3354
Examples:
3455

35-
- `Paint [A1] #FF0000`
36-
- `Paint [H8] #00FFAA`
56+
- `Paint [A1] #FF0000`
57+
- `Paint [H8] #00FFAA`
3758

3859
---
3960

40-
## Game Rules
61+
## ⏳ Rules
4162

4263
- 🕒 **One paint per user every 24 hours**
43-
- 🔒 **Each painted tile is locked for 1 hour**
64+
- 🔒 **Each tile is locked for 1 hour after being painted**
4465
- Format must match exactly:
4566
`Paint [Coordinate] #HEXCODE`
46-
- Coordinate must be between **A1 and H8**
47-
- Color must be a valid **6-digit HEX code**
48-
- Invalid format → Issue labeled `Invalid`
67+
- Only valid **6-digit HEX colors** allowed
68+
- Invalid input → Issue labeled `Invalid`
4969
- Successful paint → Issue labeled `Completed`
50-
- Every action is permanently recorded in `data/state.json`
5170

5271
---
5372

5473
## 🧠 What Is This?
5574

56-
The Global Rorschach Canvas is a shared 8×8 grid.
75+
This is not just a canvas.
76+
77+
It’s a shared system where:
5778

58-
Anyone can paint.
59-
Anyone can overwrite.
60-
No one controls the outcome.
79+
- Anyone can overwrite anything
80+
- No one has permanent control
81+
- Patterns emerge through conflict and cooperation
6182

62-
Patterns emerge.
63-
Conflicts form.
64-
Meaning is projected.
83+
Over time, the grid becomes:
6584

66-
It’s not a picture.
85+
- A drawing
86+
- A battleground
87+
- A record of behavior
6788

68-
It’s behavior.
89+
It’s not about the pixels.
90+
91+
It’s about what people do with them.
6992

7093
---
7194

7295
## ⚙️ How It Works
7396

74-
- GitHub Issue = Input
75-
- GitHub Action = Validation + Mutation
76-
- SVG (`map.svg`) = Visual State
77-
- `data/state.json` = Persistent Game State
78-
- Git commit history = Permanent ledger
97+
The entire system runs inside this repository:
98+
99+
```
100+
Issue → GitHub Action → SVG Update → Commit → README
101+
```
102+
103+
### Components
104+
105+
- `map.svg` → visual canvas
106+
- `data/state.json` → persistent game state
107+
- GitHub Actions → logic engine
108+
- Git history → permanent ledger
79109

80-
Everything happens publicly.
110+
No external services are used.
81111

82112
---
83113

84-
## 📜 Contributing
114+
## 📊 State Transparency
115+
116+
All game data is publicly stored:
117+
118+
- Last paint per user
119+
- Tile locks
120+
- Paint history
121+
122+
See: `data/state.json`
123+
124+
---
125+
126+
## 🚫 What This Is Not
127+
128+
- Not a web app
129+
- Not a real-time game
130+
- Not centrally controlled
131+
132+
This is a **slow system by design**.
133+
134+
---
135+
136+
## 🤝 Contributing
137+
138+
Want to improve the system?
139+
140+
See [`CONTRIBUTING.md`](CONTRIBUTING.md)
141+
142+
---
143+
144+
## 🧩 Core Principle
145+
146+
> Input → Mutation → Public Record
85147
86-
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for formatting rules and philosophy.
148+
That’s the entire engine.
87149

88150
---
89151

90-
Built entirely with GitHub Actions.
91-
Serverless. Deterministic. Transparent.
152+
Built entirely with GitHub.
153+
Minimal by design.

0 commit comments

Comments
 (0)