diff options
| author | Uri Shaked | 2019-11-23 22:00:00 +0200 |
|---|---|---|
| committer | Uri Shaked | 2019-11-23 22:00:00 +0200 |
| commit | c800f1c5695c4d1583251eeae99b9f8cf3623620 (patch) | |
| tree | e48a35ec9d184e6bbe56d9f870fea77ec393ea90 /README.md | |
| parent | feat: add blink demo (diff) | |
| download | avr8js-c800f1c5695c4d1583251eeae99b9f8cf3623620.tar.gz avr8js-c800f1c5695c4d1583251eeae99b9f8cf3623620.tar.bz2 avr8js-c800f1c5695c4d1583251eeae99b9f8cf3623620.zip | |
doc: README for demo, explain about running tests
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 16 insertions, 2 deletions
@@ -6,11 +6,25 @@ JavaScript implementation of the AVR 8-bit architecture ## Running the demo project -The demo project allows you to edit and run Arduino code. It includes 2 simulated LEDs -connected to pins 12 and 13 (PB4 and PB5). +The demo project allows you to edit Arduino code, compile it, and run it in the simulator. +It also simulates 2 LEDs connected to pins 12 and 13 (PB4 and PB5). To run the demo project, check out this repository, run `npm install` and then `npm start`. +## Running the tests + +Run the tests once: + +``` +npm test +``` + +Run the tests of the files you modified since last commit (watch mode): + +``` +npm run test:watch +``` + ## License Copyright (C) 2019, Uri Shaked. The code is released under the terms of the MIT license.
\ No newline at end of file |