Skip to content

Latest commit

 

History

History
82 lines (46 loc) · 1.24 KB

BUILDING.md

File metadata and controls

82 lines (46 loc) · 1.24 KB
Raw

📦 Package

The main package with base and node.js specific classes and code.js cli.

Prerequisites

  • Use Node.js and, 16.x or newer

  • Install node modules: npm install

Command

npm run build

Output

The output directory is ./package, gitignored.

📏 Tests

npm test

🔢 Zopfli WASM

This step is optional. The ./artifacts directory should already contain the compiled wasm.

Zopfli ZopfliDeflatePart function compiled into a WebAssembly binary.

Prerequisites

  • Emscripten SDK

  • The ./zopfli git submodule pulled: cd zopfli; git pull

Command

npm run build-wasm

Output

The output directory is ./artifacts.

This directory is under git version control.

📄 GitHub Pages

This step is optional if you're okay with the node cli.

Web base generator to be published on GitHub pages.

Prerequisites

  • Build the package first.

  • Install node modules in ./src/gh-pages:

cd src/gh-pages/
npm install

Command

cd src/gh-pages/
npm run build

Output

The output directory is ./gh-pages/.

This directory is a git submodule that references the git repo itself, but using the gh-pages branch.