You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README with corrections and improvements
Fix release workflow description to clarify push vs manual dispatch
behavior, correct version override instruction for release-please v4,
add Node.js prerequisite, expand tech stack, add test coverage note,
and remove outdated Firebase API disclaimer.
Copy file name to clipboardExpand all lines: README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,16 @@ Classic Minesweeper created with PixiJS. [Play the game here!](https://minesweep
4
4
5
5
Now with PixiV8 and WebGPU support.
6
6
7
-
This repository is for demonstration purposes only. Firebase API config in this sourcecode is deployed to the publicly visible front-end code and not a secret, but it will not work for you locally or when deployed to other domains.
8
-
9
7
## Getting Started
10
8
9
+
### Prerequisites
10
+
11
+
-**Node.js 20** (see `.nvmrc`) — use [nvm](https://github.com/nvm-sh/nvm) to install the correct version:
12
+
```bash
13
+
nvm install
14
+
nvm use
15
+
```
16
+
11
17
### Installation
12
18
13
19
```bash
@@ -30,7 +36,7 @@ npm install
30
36
31
37
### Testing
32
38
33
-
-**`npm test`** - Run the test suite
39
+
-**`npm test`** - Run the test suite (6 suites covering game state logic, color utilities, math helpers, event system, and utility functions)
34
40
-**`npm run test-watch`** - Run tests in watch mode (automatically re-runs on file changes)
35
41
36
42
### Code Quality
@@ -75,7 +81,7 @@ The project uses GitHub Actions for continuous integration and deployment to Fir
75
81
| Workflow | Trigger | Purpose |
76
82
|----------|---------|---------|
77
83
|**Lint & Test**| PRs to master | Runs `npm run lint` and `npm test`|
78
-
|**Release**| Push to master / manual |Creates release PRs (manual) and tags + deploys (on push after release PR merge)|
84
+
|**Release**| Push to master / manual |On **push to master**: creates tags, GitHub releases, and triggers deploy (PRs are skipped). On **manual dispatch**: creates release PRs via release-please|
79
85
|**Deploy**| Manual / called by Release | Builds and deploys to Firebase Hosting |
80
86
81
87
### Release Process
@@ -95,7 +101,7 @@ Version is determined from commit prefixes:
95
101
|`feat:`| Minor (patch while pre-1.0) | 0.0.1 → 0.0.2 |
96
102
|`feat!:` / `BREAKING CHANGE:`| Major (minor while pre-1.0) | 0.0.2 → 0.1.0 |
97
103
98
-
To override the version, add `"release-as": "x.y.z"` to the package config in `release-config.json` and commit it before running the Release workflow. Remove it after the release PR is created.
104
+
To override the version, include a `Release-As: x.y.z` footer in a commit message (e.g., `chore: prepare release\n\nRelease-As: 1.0.0`) before running the Release workflow.
99
105
100
106
### Required Secrets
101
107
@@ -111,3 +117,6 @@ To override the version, add `"release-as": "x.y.z"` to the package config in `r
111
117
-**Jest** - Testing framework
112
118
-**Spine** - 2D skeletal animation
113
119
-**Tone.js** - Web Audio framework for interactive music and sound
120
+
-**tweenjs** - Animation tweening
121
+
-**@tonejs/midi** - MIDI file parsing and playback
122
+
-**ESLint + Prettier** - Code linting and formatting
0 commit comments