tool: add monochrome readme

polldo · May 20, 2022 · a7793ac · a7793ac
1 parent dcc5bc1
commit a7793ac
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/tools/monochrome/README.md b/tools/monochrome/README.md
@@ -0,0 +1,17 @@
+# Monochrome
+
+Monochrome is a tool that converts an image to a monochrome one expressed in the format known by dolp.
+The following image formats can be consumed: bmp, jpeg, png.
+
+## How to 
+
+**Build the tool:**
+```console
+$ cd cmd/main
+$ go build -o monochrome
+```
+
+**Convert an image:**
+```console
+$ ./monochrome -i <image-path>
+```