aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
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
+```
Feel free to download, copy and edit any repo