Skip to content

Commit 7466173

Browse files
committed
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.
1 parent 76640d4 commit 7466173

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ Classic Minesweeper created with PixiJS. [Play the game here!](https://minesweep
44

55
Now with PixiV8 and WebGPU support.
66

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-
97
## Getting Started
108

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+
1117
### Installation
1218

1319
```bash
@@ -30,7 +36,7 @@ npm install
3036

3137
### Testing
3238

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)
3440
- **`npm run test-watch`** - Run tests in watch mode (automatically re-runs on file changes)
3541

3642
### Code Quality
@@ -75,7 +81,7 @@ The project uses GitHub Actions for continuous integration and deployment to Fir
7581
| Workflow | Trigger | Purpose |
7682
|----------|---------|---------|
7783
| **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 |
7985
| **Deploy** | Manual / called by Release | Builds and deploys to Firebase Hosting |
8086

8187
### Release Process
@@ -95,7 +101,7 @@ Version is determined from commit prefixes:
95101
| `feat:` | Minor (patch while pre-1.0) | 0.0.1 → 0.0.2 |
96102
| `feat!:` / `BREAKING CHANGE:` | Major (minor while pre-1.0) | 0.0.2 → 0.1.0 |
97103

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.
99105

100106
### Required Secrets
101107

@@ -111,3 +117,6 @@ To override the version, add `"release-as": "x.y.z"` to the package config in `r
111117
- **Jest** - Testing framework
112118
- **Spine** - 2D skeletal animation
113119
- **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

Comments
 (0)