Skip to content

Commit

Permalink
Restore instructions for testing Electron
Browse files Browse the repository at this point in the history
  • Loading branch information
dfabulich committed Jul 7, 2023
1 parent 54878b5 commit b2d1e1e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,9 @@ Make sure you have the latest [node.js](https://nodejs.org/en/), [Rust](https://
Install dependencies with `npm install` and then run `npm run build:debug` to build the library.

There is no way to build for all targets easily. The good news is that you don't need to. You can develop and test on your current target, and open a PR. When the code is merged to main, a github action will build for all targets and publish a new version.

### Testing Electron

Go to the [test/electron](./test/electron) directory. There, you can run `npm install` and then `npm start` to run the Electron app.

Click "activate overlay" to test the overlay.

0 comments on commit b2d1e1e

Please sign in to comment.