Hyphenation for node and Polyfill for client-side hyphenation.
Hyphenopoly has no dependencies for deployment but relies on other packages for development (devDependencies).
You need git and node.js with npm.js installed on your system.
Use
git clone https://github.com/mnater/Hyphenopoly.git
to clone the current development status (HEAD) of Hyphenopoly.js (this has the newest features, but is not fully tested).
This will create a directory called Hyphenopoly
in your current working directory containing all the files on the Hyphenopoly-GitHub-Repository. Those files are ‘connected’ to the repository: git pull
will fetch
and merge
changes from the repository to the files in your directory.
Use this to create pull-requests or to fork the repository.
While cloning gives you the most recent status, downloading a tagged release gives you a more thoughtfully tested (but never error-free) version of Hyphenopoly.
This will create a directory called Hyphenopoly
in your current working directory containing all the files on the Hyphenopoly-GitHub-Repository. Those files are NOT ‘connected’ to the repository (you can’t do git pull
and a like).
Use this if you don’t plan to make changes to Hyphenopoly that need to go upstream.
In your Hyphenopoly
-directory run npm install
. This will install the devDependencies listed in the package.json
-file to a directory called node_modules
.
This will install:
and their dependencies.
Some dependencies are not available on npm. Run npm run-script install3rdparty
. This will install more tools in a directory called third-party
.
This will install and compile binaryen.
With the tools mentioned above installed, you can run the following scripts:
npm prepare
- recreates a minified subset of the files in the min
-directory.npm test
- runs the tap tests for Hyphenopoly.module.jsnpm run testsuite
- opens a browser and runs the test suitenpm run lint
- runs the linter on all .js and .md filesnpm run createAllWasm
- compiles language-specific hyphenEngines from AssemblyScript and textPatterns (not included) to ‘./lang/’ and copies the ‘.wasm’-files to ‘./patterns/’npm run doc
- build and open documentation page locally