Skip to content

Commit 9707f19

Browse files
committed
WIP
1 parent a8e7c1b commit 9707f19

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
![Tests](https://github.com/hpcc-systems/hpcc-js-wasm/workflows/Test%20PR/badge.svg)
44
[![Coverage Status](https://coveralls.io/repos/github/GordonSmith/hpcc-js-wasm/badge.svg?branch=BUMP_VERSIONS)](https://coveralls.io/github/GordonSmith/hpcc-js-wasm?branch=BUMP_VERSIONS)
55

6-
**Note: @hpcc-js/wasm is now an ESM by default package** - this is a good thing, but does require some breaking changes.
7-
86
This repository contains a collection of useful c++ libraries compiled to WASM for (re)use in Node JS, Web Browsers and JavaScript Libraries:
97
- [base91](https://base91.sourceforge.net/) - v0.6.0
108
- [duckdb](https://github.com/duckdb/duckdb) - v1.1.1
@@ -128,3 +126,39 @@ Graphviz.load().then(graphviz => {
128126
console.log(graphviz.version());
129127
});
130128
```
129+
130+
## Build Instructions
131+
132+
The following instructions are for building the entire repository from scratch. In general the instructions assume you are running from within a bash terminal.
133+
134+
* Windows (With WSL2 and Git Bash installed)
135+
* Linux (native or WSL2)
136+
* MacOS
137+
* Docker
138+
139+
## Pre-requisites
140+
141+
To get an idea of what pre-requisites are required, please see the following files:
142+
143+
* [Dockerfile](docker/ubuntu-dev.dockerfile)
144+
* [GH Action Ubuntu](.github/workflows/test-pr.yml)
145+
* NodeJS
146+
147+
## Steps (Docker)
148+
149+
```bash
150+
git clone https://github.com/hpcc-systems/hpcc-js-wasm.git
151+
cd hpcc-js-wasm
152+
npm ci
153+
npm run build-docker
154+
```
155+
156+
## Steps (Windows, Linux, MacOS)
157+
158+
```bash
159+
git clone https://github.com/hpcc-systems/hpcc-js-wasm.git
160+
cd hpcc-js-wasm
161+
npm ci
162+
npm run install-build-deps
163+
npm run build
164+
```

0 commit comments

Comments
 (0)