Skip to content

Commit c800f1c

Browse files
committed
doc: README for demo, explain about running tests
1 parent b9dfd55 commit c800f1c

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@ JavaScript implementation of the AVR 8-bit architecture
66

77
## Running the demo project
88

9-
The demo project allows you to edit and run Arduino code. It includes 2 simulated LEDs
10-
connected to pins 12 and 13 (PB4 and PB5).
9+
The demo project allows you to edit Arduino code, compile it, and run it in the simulator.
10+
It also simulates 2 LEDs connected to pins 12 and 13 (PB4 and PB5).
1111

1212
To run the demo project, check out this repository, run `npm install` and then `npm start`.
1313

14+
## Running the tests
15+
16+
Run the tests once:
17+
18+
```
19+
npm test
20+
```
21+
22+
Run the tests of the files you modified since last commit (watch mode):
23+
24+
```
25+
npm run test:watch
26+
```
27+
1428
## License
1529

1630
Copyright (C) 2019, Uri Shaked. The code is released under the terms of the MIT license.

demo/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AVR8js Demo
2+
3+
AVR8js + Monaco Editor. To run this demo:
4+
5+
1. Install dependencies: `npm install`
6+
2. Start the code: `npm start`
7+
3. Go to http://localhost:1234/ and start tinkering
8+
9+
The demo is configured to automatically reload the app whenever you change the code.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"prepare": "npm run build",
1313
"start": "parcel demo/src/index.html -d demo/build",
1414
"lint": "tslint --project tsconfig.json",
15-
"test": "jest"
15+
"test": "npm run lint && jest",
16+
"test:watch": "jest --watch"
1617
},
1718
"files": [
1819
"dist"

0 commit comments

Comments
 (0)