aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSan Jacobs2020-02-26 02:07:18 +0100
committerSan Jacobs2020-02-26 02:07:18 +0100
commitcbd9ef44e38fbff48af92405e0229b6a779fabe0 (patch)
tree0ea27933bade80cbe7212d89aa079dfb642a278d /README.md
parent20a8ab44a1fb0090c6bd20141ecaef8d75015f5c (diff)
downloadfilmstripper-cbd9ef44e38fbff48af92405e0229b6a779fabe0.tar.gz
filmstripper-cbd9ef44e38fbff48af92405e0229b6a779fabe0.tar.bz2
filmstripper-cbd9ef44e38fbff48af92405e0229b6a779fabe0.zip
Wrote basic README
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 492d21a..4a08864 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# filmstripper
+# Filmstripper
+A tool for fusing multiple images together into a single filmstrip.
+
+## Usage
+
+Filmstripper takes a folder as input and a file-path as output. It can generate both vertical and horizontal filmstrips, the choice is made by either writing `v` for vertical, or `h` for horizontal. Vertical is the default, if nothing else is chosen.
+
+```
+python3 filmstripper.py /input/directory/ /output/file.png [v/h]
+```
+
+## Examples
+
+`N/A`