From c800f1c5695c4d1583251eeae99b9f8cf3623620 Mon Sep 17 00:00:00 2001 From: Uri Shaked Date: Sat, 23 Nov 2019 22:00:00 +0200 Subject: doc: README for demo, explain about running tests --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b6d48e3..98c2743 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3