From e2fc6fcd524bbd3762ab57155bd515ce690adf51 Mon Sep 17 00:00:00 2001
From: jvech <jmvalenciae@unal.edu.co>
Date: Thu, 22 Jun 2023 08:06:52 -0500
Subject: doc: help message and README added

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a2bdab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Dsco
+
+A simple ppm image processor, that use convolution to transform images
+
+## Usage
+
+If `INPUT` is not specified the program will use standard input.
+
+```
+Usage:
+    dsco [INPUT] -f [edge|blur|sharpen] [-o OUTPUT]
+
+Options:
+    -o      output file [default: /dev/stdout] 
+    -f      filter to use
+
+            edge:       -1 -1 -1
+                        -1  8 -1
+                        -1 -1 -1
+
+            sharpen:     0 -1  0
+                        -1  5 -1
+                         0 -1  0
+
+            blur:        1  2  1
+                   1/16  2  4  2
+                         1  2  1
+```
-- 
cgit v1.2.3-70-g09d2