Skip to content

Commit

Permalink
Merge pull request #80 from tsoding/76
Browse files Browse the repository at this point in the history
(#76) Document Development workflow
  • Loading branch information
rexim authored Jun 20, 2021
2 parents 3219b60 + e6aa6db commit f653e6a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ jobs:
node-version: '13'
- run: npm install
- run: ./node_modules/.bin/tsc
- run: git diff --exit-code
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ $ python3 -m http.server 6969
$ iexplore.exe http://localhost:6969/
```

## Development Workflow

1. `$ npm install`
2. `$ ./node_modules/.bin/tsc -w`
3. `<edit files>`

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.

# Filter Development

**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!**
Expand Down

0 comments on commit f653e6a

Please sign in to comment.