diff --git a/README.md b/README.md index 5a209e9..ccb41a9 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@

Pigo Wasm demos

-This repository is a collection of Webassembly demos running real time and using the [Pigo](https://github.com/esimov/pigo) face detection library, showcasing various potential use cases. **It is continuously updated**. +This repository is a collection of Webassembly demos (which means they are running in the Web browser) showcasing a few examples of using the [Pigo](https://github.com/esimov/pigo) face detection library in real time. **This library meant to be continuously updated**. ## Install **Notice: at least Go 1.13 is required in order to run the demos!** ```bash -$ go get -u -v github.com/esimov/pigo-wasm-demos - +$ go install github.com/esimov/pigo-wasm-demos@latest ``` ## Run -Running the demo is as simple as typing a single line of command. This will build the package and produce an executable WebAssembly file which can be served over a http server. A new tab will be opened automatically in the user's default browser. + +You only need to type `$make demo{no}`. This will build the package and produce an executable WebAssembly file which can be served over an http server. A new tab will be opened automatically in the user's default browser. ## Demos @@ -27,7 +27,7 @@ $ make demo1 #### Key bindings: -q - Show/hide detected face marker
+q - Show/hide the detected face rectangle
z - Show/hide pupils
w - Show/hide eye mask
s - Show/hide mouth mask
@@ -44,24 +44,23 @@ $ make demo2 ![pigo_wasm_faceblur](https://user-images.githubusercontent.com/883386/170483688-5a145550-5a7b-4400-af34-842333fb1a8e.gif) #### Key bindings: -f - Show/hide detected face marker
-s - Show/hide pupils
-b - Enable/disable face blur
] - Increase the blur radius
[ - Decrease the blur radius
+f - Show/hide the detected face rectangle
+s - Show/hide pupils
+b - Enable/disable face blur
-### Background blur in Zoom style +### Background blur (in Zoom style) ```bash $ make demo3 ``` ![pigo_wasm_background_blur](https://user-images.githubusercontent.com/883386/170483670-2ad0f865-d89d-44c4-8cb5-f9d5736d12fb.gif) #### Key bindings: -f - Show/hide detected face marker
-s - Show/hide pupils
-b - Enable/disable face blur
] - Increase the blur radius
[ - Decrease the blur radius
+f - Show/hide the detected face rectangle
+s - Show/hide pupils
### Face triangulator ```bash @@ -70,7 +69,7 @@ $ make demo4 ![pigo_wasm_triangulate](https://user-images.githubusercontent.com/883386/170484192-c43bafa5-36c6-41a8-9e23-3f3d04264b08.gif) #### Key bindings: -f - Show/hide detected face marker
+f - Show/hide the detected face rectangle
s - Show/hide pupils
= - Increase the number of triangles
- - Decrease the number of triangles
@@ -87,7 +86,7 @@ $ make demo5 ![pigo_wasm_pixelate](https://user-images.githubusercontent.com/883386/170484527-b98745e5-5f93-45cb-a86d-ed12332c8d41.gif) #### Key bindings: -f - Show/hide detected face marker
+f - Show/hide the detected face rectangle
s - Show/hide pupils
= - Increase the number of colors
- - Decrease the number of colors
@@ -96,7 +95,7 @@ $ make demo5 ### Triangulated facemask ```bash -$ make demo5 +$ make demo6 ``` ![facemask](https://user-images.githubusercontent.com/883386/132861943-5f130ec2-dae2-4034-9abd-4c9de0de066c.gif)