Skip to content

Commit d393928

Browse files
committed
Added an icon for the project, and a README.md documentatioN.
1 parent 57f403a commit d393928

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# JavaScript interpreter for the NumWorks calculator
2+
3+
[![Build](https://github.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/actions/workflows/build.yml/badge.svg)](https://github.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/actions/workflows/build.yml)
4+
5+
This apps lets you run a [JavaScript](https://en.wikipedia.org/wiki/JavaScript) script on your [NumWorks calculator](https://www.numworks.com)!
6+
[![JavaScript logo](./src/icon.png)](https://en.wikipedia.org/wiki/JavaScript)
7+
8+
## Install the app
9+
10+
Installing is rather easy:
11+
12+
1. Download the latest `javascript.nwa` file from the [Releases](https://github.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/releases) page ;
13+
2. This Release page is not-yet ready on this project, use [this folder instead](https://perso.crans.org/besson/publis/Numworks-apps/), and [this link](https://perso.crans.org/besson/publis/Numworks-apps/javascript.nwa) ;
14+
3. Head to [my.numworks.com/apps](https://my.numworks.com/apps) to send the `nwa` file on your calculator (on Google Chrome browser). On [this page](https://my.numworks.com/python/lilian-besson-1/javascript) you will be able to also send a default example of a JavaScript file (a tiny test script), and you can edit it yourself later on, on your calculator.
15+
16+
## How to use the app
17+
18+
Just launch the app, and it will read and execute your script `javascript.py`!
19+
20+
This script should be located in the `javascript.py` file, that you can create, edit and save **from within your NumWorks!**.
21+
22+
If you want a demo, use [this `javascript.py` script](https://my.numworks.com/python/lilian-besson-1/javascript), that you can install on your NumWorks calculator, directly from their website (from my user space).
23+
24+
## Dependencies
25+
26+
This programs uses the code generated by the Espruino project, a portable JavaScript interpreter for microcontrolers.
27+
28+
## Build the app
29+
30+
To build this sample app, you will need to install the [embedded ARM toolchain](https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain) and [nwlink](https://www.npmjs.com/package/nwlink).
31+
32+
```shell
33+
brew install numworks/tap/arm-none-eabi-gcc node # Or equivalent on your OS
34+
npm install -g nwlink
35+
make clean && make build
36+
```
37+
38+
----
39+
40+
## :scroll: License ? [![GitHub license](https://img.shields.io/github/license/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator.svg)](https://github.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/blob/master/LICENSE)
41+
42+
[MIT Licensed](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)).
43+
© [Lilian Besson](https://GitHub.com/Naereen), 2025.
44+
45+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/A-JavaScript-interpreter-for-the-NumWorks-calculator/graphs/commit-activity)
46+
[![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama)
47+
48+
[![ForTheBadge built-with-swag](http://ForTheBadge.com/images/badges/built-with-swag.svg)](https://GitHub.com/Naereen/)
49+
[![ForTheBadge uses-badges](http://ForTheBadge.com/images/badges/uses-badges.svg)](http://ForTheBadge.com)
50+
[![ForTheBadge uses-git](http://ForTheBadge.com/images/badges/uses-git.svg)](https://GitHub.com/)
51+
[![ForTheBadge uses-js](http://ForTheBadge.com/images/badges/uses-js.svg)](http://ForTheBadge.com)
52+

src/icon.png

1.35 KB
Loading

0 commit comments

Comments
 (0)