Skip to content

Commit f653e6a

Browse files
authored
Merge pull request #80 from tsoding/76
(#76) Document Development workflow
2 parents 3219b60 + e6aa6db commit f653e6a

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ jobs:
1111
node-version: '13'
1212
- run: npm install
1313
- run: ./node_modules/.bin/tsc
14+
- run: git diff --exit-code

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ $ python3 -m http.server 6969
1717
$ iexplore.exe http://localhost:6969/
1818
```
1919

20+
## Development Workflow
21+
22+
1. `$ npm install`
23+
2. `$ ./node_modules/.bin/tsc -w`
24+
3. `<edit files>`
25+
26+
Make sure that you commit the generated `js/*` files along with your changes. This is important for the project to retain that "Just deploy the repo" attitude.
27+
2028
# Filter Development
2129

2230
**WARNING! Knowledge of [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) or [OpenGL](https://www.opengl.org/) is required to read this section!**

0 commit comments

Comments
 (0)