Skip to content

Commit 74d0344

Browse files
authored
Update README.md
1 parent 7e72cc4 commit 74d0344

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# mJS3 - a JS engine for embedded Arduino IDE systems
1+
### ESP8266-Arduino-JavaScript - JavaScript scripting engine in Arduino IDE for ESP8266
22

33
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
44

5-
mJS3 is a single-source-file JavaScript engine for Arduino IDE microcontrollers.
5+
ESP8266-Arduino-JavaScript is a Arduino IDE Library to implement a JavaScript engine for Arduino IDE ESP8266 microcontroller.
66

7-
## Demo Install
7+
## Library Install
88

9-
- Download (Clone) this github repository and copy the folder (as is no need to rename it) into your user Arduino Folder (C:\Users\USER\Documents\Arduino\mjs3-Arduino)
10-
- Load the sketch using the Arduino IDE menu (File->Sketchbook->mjs3-Arduino)
11-
- Build and Upload (*note: currently does not build on AVR platforms)
9+
- Download the latest github release zip file [ESP8266-Arduino-JavaScript-0.0.12](https://github.com/sfranzyshen/ESP8266-Arduino-JavaScript/releases/download/0.0.12/ESP8266-Arduino-JavaScript-0.0.12.zip)
10+
- In the Arduino IDE, navigate to Sketch > Include Library > Add .ZIP Library. At the top of the drop down list, select the option to "Add .ZIP Library''.
11+
- You will be prompted to select the library you would like to add. Navigate to the .zip file's location and open it.
12+
- Load the demo sketch using the Arduino IDE menu (File->Examples->ESP8266-Arduino-JavaScript->blink)
13+
- Build and Upload.
1214

1315
## Features
1416

@@ -28,11 +30,10 @@ mJS3 is a single-source-file JavaScript engine for Arduino IDE microcontrollers.
2830
- mJS VM executes JS source directly, no AST/bytecode is generated
2931
- Simple FFI API to inject existing C functions into JS
3032

31-
## Example - blinky in JavaScript on Arduino Platform
33+
## Example - blink in JavaScript on Arduino IDE ESP8266 Platform
3234

3335
```c++
34-
#define MJS_STRING_POOL_SIZE 200 // Buffer for all strings
35-
#include "mjs3-Arduino.c"
36+
#include <mjs3.h>
3637

3738
extern void myDelay(int x) {
3839
delay(x);
@@ -59,8 +60,8 @@ void loop() {
5960
```
6061
6162
```
62-
Sketch uses 272668 bytes (26%) of program storage space. Maximum is 1044464 bytes.
63-
Global variables use 27812 bytes (33%) of dynamic memory, leaving 54108 bytes for local variables. Maximum is 81920 bytes.
63+
Sketch uses 271568 bytes (26%) of program storage space. Maximum is 1044464 bytes.
64+
Global variables use 27828 bytes (33%) of dynamic memory, leaving 54092 bytes for local variables. Maximum is 81920 bytes.
6465
```
6566
6667
## Supported standard operations and constructs

0 commit comments

Comments
 (0)