@mlightcad/libredwg-web 0.0.1

package/README.md

@@ -0,0 +1,85 @@
+# libredwg-web
+
+This is a webassembly version of libredwg. It can be used in browser and Node.js environments. 
+
+You can play with it through this [live demo](https://mlight-lee.github.io/libredwg-web/).
+
+## Build WebAssembly
+
+Download and install emscripten according to [this doc](https://emscripten.org/docs/getting_started/downloads.html). Please make sure the following command is executed to activate `PATH` and other environment variables in the current terminal before building web assembly.
+
+```bash
+# Activate PATH and other environment variables for emscripten in the current terminal
+source ./emsdk_env.sh
+
+./autogen.sh
+
+# Install npm dependencies to build JavaScript bindings for libredwg
+pnpm install
+
+# Check for dependencies, available tools, and system configurations and prepare the software package for building libredwg on a specific system
+pnpm build:prepare
+
+# Compile and build libredwg
+pnpm build:obj
+
+# Use emscripten to build web assembly for libredwg
+pnpm build:wasm
+
+# Copy web assembly (wasm file and JavaScript glue code file) from build directory to distribution directory of this package
+nnpm copy
+
+# Build web assembly wrapper so that it is easier to use it
+pnpm build
+```
+
+In order to reduce the size of wasm file, the following functionalities are not included by default when building web assembly.
+
+- write dwg file
+- read/write dxf file
+- import/export json file
+
+If you want those functionalities, just modify command `build:prepare` defined in [package.json](./package.json) and remove the following options.
+
+- disable-write
+- disable-json
+- disable-dxf
+
+## Usage
+
+There are two approaches to use this package. No matter which approach to use, please do remember copying wasm file (libredwg.wasm) to the same folder as your JavaScript bundle file when deploying your application. 
+
+### Use Raw Web Assembly
+
+The raw web assembly module (wasm file and JavaScript glue code file) is stored in folder [wasm](./wasm/). 
+
+```javascript
+import createModule from "@mlightcad/libredwg-web/wasm/libredwg-web.js";
+const libredwg = await createModule();
+
+// The second paramter represents file types
+// - 0: dwg file
+// - 1: dxf file
+const dwg = libredwg.dwg_read_data(fileContent, 0);
+```
+
+### Use Web Assembly Wrapper
+
+Web assembly wrapper is stored in folder [dist](./dist/). It provides one class `LibreDwg` to wrap the web assembly. This class provides
+
+- More methods that the raw web assembly API doesn't provide. 
+- More accurated type definition so that it is easy to understand API.
+
+```typescript
+import { Dwg_File_Type, LibreDwg } from '@mlightcad/libredwg-web';
+const libredwg = await LibreDwg.create();
+const dwg = libredwg.dwg_read_data(fileContent, Dwg_File_Type.DWG);
+```
+
+## Demo App
+
+One demo app is provided in folder [test](./test/). You can run the following command to launch it.
+
+```javascript
+pnpm dev
+```