ext2fs - npm Package Compare versions

Comparing version 3.1.1-improve-symlink-ae514cee2bb7f2d42ed26c06d9c70f6429e48cb1 to 3.1.1-patch-2-82d4f8770e47315c091c896aadbc6bbc69075517

CHANGELOG.md

@@ -11,2 +11,3 @@ # Change Log
 * add lstat support [Zane Hitchcox]
+* add Building section to readme (explain submodule) [Forest Johnson]
 
@@ -13,0 +14,0 @@ # v3.1.0

package.json

 {
   "name": "ext2fs",
-  "version": "3.1.1-improve-symlink-ae514cee2bb7f2d42ed26c06d9c70f6429e48cb1",
+  "version": "3.1.1-patch-2-82d4f8770e47315c091c896aadbc6bbc69075517",
   "description": "WASM bindings to libext2fs for cross-platform ext filesystem handling",
@@ -48,4 +48,4 @@ "author": "Petros Angelatos <[e-mail]>",
   "versionist": {
-    "publishedAt": "2022-07-07T19:56:31.877Z"
+    "publishedAt": "2022-07-07T22:23:00.207Z"
   }
 }

README.md

@@ -40,2 +40,3 @@ node-ext2fs
 
+
 Usage
@@ -83,2 +84,20 @@ -----
 
+Building
+--------
+
+`node-ext2fs` uses a git submodule for [e2fsprogs](https://github.com/tytso/e2fsprogs). 
+This means if you wish to build it, **you have to init/update the git submodule first**. 
+
+``` bash
+$ git submodule update --init --recursive
+```
+
+For more information on git submodules, see https://stackoverflow.com/questions/1030169/easy-way-to-pull-latest-of-all-git-submodules.
+
+Once the submodule has been initialized/pulled, simply run:
+
+```
+npm run build
+```
+
 Support
@@ -85,0 +104,0 @@ -------

No alert changes

Improved metrics

Total package byte prevSize

384037

increased by0.14%

Number of lines in readme file

114

increased by20%

No dependency changes