Skip to content

Commit

Permalink
Update conversion documentation for Node.js
Browse files Browse the repository at this point in the history
We now only support conversion to CommonJS, in order to support Node.js
older than version 15.
  • Loading branch information
CendioOssman committed Dec 30, 2020
1 parent 3222230 commit adfb99e
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/LIBRARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,14 @@ do things.

## Conversion of Modules

noVNC is written using ECMAScript 6 modules. Many of the major browsers support
these modules natively, but not all. They are also not supported by Node.js. To
use noVNC in these places the library must first be converted.
noVNC is written using ECMAScript 6 modules. This is not supported by older
versions of Node.js. To use noVNC with those older versions of Node.js the
library must first be converted.

Fortunately noVNC includes a script to handle this conversion. Please follow
the following steps:

1. Install Node.js
2. Run `npm install` in the noVNC directory
3. Run `./utils/use_require.js --as <module format>`

Several module formats are available. Please run
`./utils/use_require.js --help` to see them all.

The result of the conversion is available in the `lib/` directory.

0 comments on commit adfb99e

Please sign in to comment.