Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
flxkrmr committed Mar 24, 2023
1 parent 8c20e80 commit 112ff65
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# EEC IV Reader GUI

GUI for the EEC IV Reader: https://github.com/flxkrmr/eec-iv-reader-arduino

Download Installer https://github.com/flxkrmr/eec-iv-reader-gui/releases/latest

Tested on Windows 10.

## Usage

When GUI ist started, connect Reader with USB and press "Connect". The Reader should restart on connection. Then select a mode on the Reader. The GUI will show when a reading has started and display the results.

## Commands
### Local startup
```
npm install
npm run start
```
### Creating installer
```
npm run make
```
### Publish Release draft to Github
```
set GITHUB_TOKEN=xxx
npm run publish
```

0 comments on commit 112ff65

Please sign in to comment.