summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 98417b0..3fcbc38 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
# xplane-video
-Process outputted videos from xplane \ No newline at end of file
+Process outputted videos from xplane
+
+## Configuration
+Copy the `config/app.php.example` file to `config/app.php` and adjust the paths to your preffered options.
+
+## Execution
+`php scripts/run.php` interactively lists videos and allows for specific video processing
+
+`php scripts/run.php --pretend` interactive lists videos and shows what commands would be run without any execution.
+
+## TODO
+Currently the thing that works is processing a single video.
+Eventually this will be able to process multiple videos, and cobine videos!