about summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-11-03 23:07:19 +0530
committerAndinus <andinus@nand.sh>2021-11-03 23:07:19 +0530
commitf82aa5441c24b3c2f08b019bd2b04e02d845fa41 (patch)
tree328d24c45ad4a4a9d751c58f5546c2819a0cba25 /README.org
parent55e355c0a32de0bcf12f4a52ae7ac3b072f0bf66 (diff)
downloadfornax-f82aa5441c24b3c2f08b019bd2b04e02d845fa41.tar.gz
Document options
Diffstat (limited to 'README.org')
-rw-r--r--README.org6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.org b/README.org
index df63385..eb39e48 100644
--- a/README.org
+++ b/README.org
@@ -72,6 +72,12 @@ later converted to a slideshow with ~ffmpeg~.
 - *Note*: If the number of iterations are greater than an 8 digit number
   then the slideshow might be incorrect.
 
+** Options
+
+- ~input~: This takes solved input file in the /Fornax/ format.
+- ~frame-rate~: Frame rate for the video.
+- ~output~: Output directory (for solution video/images).
+
 * Project Structure
 
 - Algorithms are located in ~algorithms/~ directory, sub-directory needs