You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-3Lines changed: 24 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,16 @@
3
3
4
4
A MiniScript implementation written in TypeScript.
5
5
6
-
Works in the browser or on Node.js.
6
+
At the moment this project is not published either in a CDN for browser consumption nor as an NPM package to be used in Node.js. You will have to build locally. See section below.
7
7
8
-
At the moment this project is not published either in a CDN for browser consumption nor as an NPM package to be used in Node.js. You will have to build locally.
8
+
## Features
9
+
10
+
* Runs both on the browser and Node.js
11
+
* Fully passes the "TestSuite.txt" from the official C# implementation
12
+
* Performance similar to Mini Micro on the desktop
13
+
* Extensible via custom intrinsic functions
14
+
* Easy integration with JavaScript, as it uses native JS data-types (except for "map")
15
+
* Usable in TypeScript projects (type definitions provided)
9
16
10
17
## Building
11
18
@@ -45,8 +52,22 @@ Consult the [examples/nodejs](examples/browser/) folder.
45
52
46
53
Note that you will need to build locally for the examples to work.
47
54
55
+
## Testing
56
+
57
+
The test suites can be run from the command line with:
58
+
59
+
```
60
+
npm run test
61
+
```
62
+
63
+
Alternatively you can open a browser-based UI with:
64
+
65
+
```
66
+
npm run test-ui
67
+
```
68
+
48
69
## Acknowledgements
49
70
50
71
Many thanks to the amazing MiniScript community at Discord, for their encouragement during the development of this project.
51
72
52
-
Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible.
73
+
Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible.
0 commit comments