summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFBeans <phil@pgburton.com>2022-03-06 16:26:07 +0000
committerFBeans <phil@pgburton.com>2022-03-06 16:26:07 +0000
commit88667d540736c39b7a78601d7abb6f3108a7a65c (patch)
treeea13cf9914b502d8749b94db36074defbefc812a /README.md
parentcc5e12a25f626dd5b01ca48ecf30661c2168f776 (diff)
Inital commitHEADmain
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!