Skip to content
This repository was archived by the owner on Aug 5, 2022. It is now read-only.

Commit 147bb63

Browse files
dbkinderpoussa
authored andcommitted
Updated README (#262)
* Updated README Did a quick editing pass to check for proper trademark usage and did some clarity and formatting edits along the way. * Update README.md
1 parent 2937bf0 commit 147bb63

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# JavaScript* Runtime for Zephyr* OS
1+
# JavaScript\* Runtime for Zephyr™ OS
22

3-
The JavaScript Runtime for Zephyr OS project (ZJS for short) provides an IoT
3+
The JavaScript\* Runtime for the Zephyr™ OS project (ZJS for short) provides an IoT
44
web runtime environment with JavaScript APIs for the Zephyr operating system,
5-
based on the JerryScript engine. It is intended for systems with low memory
5+
based on the JerryScript engine. It is intended for systems with little memory
66
where Node.js with V8 is too big.
77

8-
This code requires a local copy of JerryScript and Zephyr source, and we
8+
This code requires a local copy of JerryScript and Zephyr OS source. We
99
will upstream patches to those projects as appropriate, but this repo is for
1010
everything else.
1111

1212
## Getting Started
1313

1414
This section will walk you through building and running your first ZJS
15-
application on Arduino 101.
15+
application on Arduino 101\*.
1616

1717
### Prerequisites
1818
* [Arduino 101 board](https://www.arduino.cc/en/Main/ArduinoBoard101)
19-
* Ubuntu 16.04 host; adapt as necessary for other platforms.
19+
* Ubuntu\* 16.04 host; adapt as necessary for other platforms.
2020
* If you're behind a proxy, go through all the [usual pain]
2121
(https://github.com/01org/zephyr.js/wiki/Proxy) to get ssh working to
2222
github.com and http working to zephyrproject.org.
@@ -39,7 +39,7 @@ $ git clone http://github.com/01org/zephyr.js.git
3939
```
4040

4141
#### Install the Zephyr SDK
42-
Download the [latest Zephyr SDK] (https://nexus.zephyrproject.org/content/repositories/releases/org/zephyrproject/zephyr-sdk/), then:
42+
Download the [latest Zephyr SDK] (https://www.zephyrproject.org/downloads/tools), then:
4343
```bash
4444
$ chmod +x /path/to/zephyr-sdk-<VERSION>-i686-setup.run
4545
$ sudo /path/to/zephyr-sdk-<VERSION>-i686-setup.run
@@ -48,15 +48,14 @@ $ sudo /path/to/zephyr-sdk-<VERSION>-i686-setup.run
4848
Follow the prompts, but the defaults should be fine.
4949

5050
#### Set up Zephyr SDK environment variables
51-
It is recommended that you add the following two lines to your `~/.bashrc` so
52-
that you don't have to type them again. If you installed your Zephyr SDK
51+
Add the following two lines to your `~/.bashrc`. If you installed your Zephyr SDK
5352
elsewhere, adjust as needed.
5453
```bash
5554
export ZEPHYR_GCC_VARIANT=zephyr
5655
export ZEPHYR_SDK_INSTALL_DIR=/opt/zephyr-sdk
5756
```
5857

59-
Then source the .bashrc again:
58+
Then source the .bashrc :
6059
```bash
6160
$ source ~/.bashrc
6261
```
@@ -162,8 +161,8 @@ commands. If not, press the Master Reset button, and either way do:
162161
$ make dfu
163162
```
164163

165-
After this completes flashing successfully, reboot the device with the Master
166-
Reset button to start the application, and after a few seconds the onboard LEDs
164+
After this flashing completes successfully, reboot the device with the Master
165+
Reset button to start the application. After a few seconds the onboard LEDs
167166
should start cycling.
168167

169168
You have built and run your first ZJS application!
@@ -178,22 +177,22 @@ you just need to repeat the last two steps with the desired JavaScript filename.
178177
Without the serial console set up, you won't be able to see error messages and
179178
other output from your ZJS application. To hook up the serial console, you need
180179
a USB to TTL Serial Cable, such as the TTL-232R-3V3. On that particular cable,
181-
you wire the black wire to ground on the Arduino, the orange wire to GPIO pin 0
180+
you wire the black wire to ground on the Arduino 101 board, the orange wire to GPIO pin 0
182181
(RX), and the yellow wire to GPIO pin 1 (TX). The other three are unused.
183182

184-
When you plug this in, the device should show up as something like
183+
When you plug this in, the device should show up as something such as
185184
`/dev/ttyUSB0`. You can then use the screen command to connect to the device
186-
with a command like this:
185+
with a command such as this:
187186

188187
```bash
189188
$ watch screen /dev/ttyUSB0 115200
190189
```
191190

192-
The watch utility will restart screen you disconnect and reconnect your
193-
Arduino, so you shouldn't miss anything. You can leave a dedicated terminal
191+
The `watch` utility will restart screen when you disconnect and reconnect your
192+
Arduino 101, so you shouldn't miss anything. You can leave a dedicated terminal
194193
running to watch the output.
195194

196-
In screen, you can view scrollback with Ctrl-a, Esc, followed by PgUp/PgDn.
195+
In `screen`, you can scroll back the output with Ctrl-A, Esc, followed by PgUp/PgDn.
197196
Then Esc again to get back to the latest output (out of "Copy Mode").
198197

199198
#### Debugging
@@ -204,7 +203,7 @@ to connect to the device with a debugger. Then you can set breakpoints such as
204203

205204
#### Additional details
206205

207-
See below for more details, such as increasing the space available for your
206+
See below for a few more tips, such as increasing the space available for your
208207
application on the Arduino 101, or how to use ZJS with the FRDM-K64F.
209208

210209
## Contributing
@@ -247,8 +246,8 @@ you ([email protected]). I need to make sure of the license details before
247246
I add it to the repo.
248247

249248
The ZJS_PARTITION environment variable, set automatically by zjs-env.sh, is
250-
what controls whether the build targets 144KB or 256KB. The symptom if you use
251-
the wrong one is that the ARC side won't come up, because we'll be attempting
249+
what controls whether the build targets 144KB or 256KB. If you use
250+
the wrong one, the ARC side won't come up because we'll be attempting
252251
to start it from the wrong place on the flash. (Note: both the ARC and X86
253252
images have to be rebuilt and reflashed when you switch partition sizes.)
254253

@@ -295,7 +294,7 @@ attempt the DFU command, or it will fail.)
295294
$ make JS=samples/HelloWorld.js
296295
```
297296

298-
This will build the system image, resulting in outdir/zephyr.bin as the final
297+
This will build the system image, resulting in `outdir/zephyr.bin` as the final
299298
output. To flash this to your device with dfu-util, first press the Master Reset
300299
button on your Arduino 101, and about three seconds later type:
301300

@@ -316,18 +315,19 @@ as with `HelloWorld.js` above.
316315

317316
## JS Minifier
318317

319-
To save space it is recommended to use a minifier. In convert.sh, the script
320-
used to encode your JS into a source file, we use uglifyjs. If you didn't
318+
To save space it is recommended to use a minifier. In `convert.sh`, the script
319+
used to encode your JS into a source file, we use `uglifyjs`. If you didn't
321320
install this earlier, you can do so with the command:
322321
```bash
323322
sudo apt-get install node-uglify
324323
```
325324

326325
## FRDM-K64F Platform
327326

328-
See the [Zephyr Wiki] (https://wiki.zephyrproject.org/view/NXP_FRDM-K64F) for general information about Zephyr on the FRDM-K64F.
327+
See the [Zephyr Project Wiki] (https://wiki.zephyrproject.org/view/NXP_FRDM-K64F) for general information
328+
about running Zephyr OS on the FRDM-K64F.
329329

330-
The instructions below are assuming Ubuntu 14.04 on the host PC.
330+
The instructions below assume Ubuntu 14.04 on the host PC.
331331

332332
Connect a micro-USB cable from the device to your PC.
333333

@@ -342,12 +342,12 @@ or
342342
$ minicom -D /dev/ttyACM0
343343
```
344344

345-
worked for me, but I typically had to try either command several times before it
346-
would work. The benefit of minicom is it will keep running even if you unplug
345+
(I typically had to try either command several times before it
346+
would work.) The benefit of minicom is it will keep running even if you unplug
347347
the cable and then plug it back in later.
348348

349-
(Check your dmesg output or watch your /dev directory to know what device it
350-
shows up as.)
349+
Check your dmesg output or watch your /dev directory to know what device it
350+
shows up as.
351351

352352
Then, follow [these instructions] (https://developer.mbed.org/handbook/Firmware-FRDM-K64F) to update your firmware.
353353

@@ -357,16 +357,16 @@ $ make BOARD=frdm_k64f JS=samples/HelloWorld.js
357357
$ cp outdir/zephyr.bin /media/<USERNAME>/MBED/
358358
```
359359

360-
After you copy the new .bin file to that directory, the device will reboot,
361-
blink an LED quickly as it writes the image somewhere, and then you should see
360+
After you copy the new `.bin` file to that directory, the device will reboot,
361+
blink an LED quickly as it writes the image, and then you should see
362362
the device reconnect as a USB storage device to your PC. Then you can press the
363363
Reset button to run the Zephyr image. You should see "Hello, ZJS world!" output
364364
on the serial console in less than a second.
365365

366366
If something doesn't work, you may want to establish that you're able to
367367
upload the K64F [hello world application] (https://developer.mbed.org/platforms/FRDM-K64F/#flash-a-project-binary).
368368

369-
Then, you could try the Zephyr hello_world sample to narrow down the problem:
369+
Then, you could try the Zephyr OS `hello_world` sample to narrow down the problem:
370370
```bash
371371
$ cd deps/zephyr/samples/hello_world/nanokernel
372372
$ make pristine && make BOARD=frdm_k64f
@@ -376,4 +376,4 @@ $ cp outdir/zephyr.bin /media/<USERNAME>/MBED/
376376
Using the same procedure as above, once you hit Reset you should see
377377
"Hello World!" within a second on your serial console.
378378

379-
*Other names and brands may be claimed as the property of others.
379+
Zephyr is a trademark of the Linux Foundation. *Other names and brands may be claimed as the property of others.

0 commit comments

Comments
 (0)