Skip to content

Commit f21429d

Browse files
committed
Update the README file for beta.4
1 parent 26c9c71 commit f21429d

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11
# Development repository for MathJax v3 #
22

3-
MathJax v3 is now in beta release; see the [beta branch](https://github.com/mathjax/mathjax-v3/tree/beta) for details. See the [https://github.com/mathjax/mj3-demos](https://github.com/mathjax/mj3-demos) for examples and webpacked files for the beta release.
3+
MathJax v3 is now in beta release; see the [beta branch](https://github.com/mathjax/mathjax-v3/tree/beta) for details. See the [https://github.com/mathjax/mj3-demos](https://github.com/mathjax/mj3-demos) for examples of using MathJax v3 in webpages, and [https://github.com/mathjax/mj3-demos-node](https://github.com/mathjax/mj3-demos-node) for examples of using MathJax v3 in node applications.
44

5-
The `master` branch is not the beta release. It is the current development copy, set up for development testing, as described below.
5+
See the [release notes](https://github.com/mathjax/mathjax-v3/releases) for details of the changes in this beta release. See the examples linked above for documentation on how to use and configure MathJax for use in browsers or node applications. More documentation will be forthcoming as part of the official version 3.0.0 release currently being prepared.
6+
7+
The `master` branch is not the beta release. It is the current development copy, set up for development testing, as described below. Check out the `beta.4` branch to obtain the beta release code.
68

79
---
810

9-
There are two bootstrap files for running the code:
11+
There are three bootstrap files for running the code:
1012

11-
* `load.js` for running in node (`node load`), and
13+
* `load.js` for running in node (`node load`),
14+
* `load.mjs` for running node in ES6 module mode, and
1215
* `load.html` for running in a browser.
1316

1417
These allow you to specify a test file to run. For example,
1518

1619
node load samples/filename.js
1720

21+
or
22+
23+
node load.mjs samples/filename.js
24+
1825
will run the file `samples/filename.js`, while entering
1926

2027
load.html?samples/filename.js
@@ -33,4 +40,8 @@ would load `tex2html.js` passing it `x+1` in `process.argv[3]`.
3340

3441
Both `load.js` and `load.html` use `System.js` to manage the loading of version 3 files. In some browsers (e.g., Firefox), you get syntax errors for the files as they load, but that seems to be some side-effect of how `System.js` works. The code is OK and runs properly anyway.
3542

36-
There is a tiny document in the `docs` directory that gives the basic structures and some sample code, but it is woefully inadequate at the moment, and may be out of date. More to come later.
43+
The `load.mjs` file uses node's native implementation of ES6 modules, and processes the `import` and `export` commands automatically. To write files that don't rely on `load.mjs`, you can use
44+
45+
node -r esm filename.js
46+
47+
and simply import the needed MathJax code.

0 commit comments

Comments
 (0)