about summary refs log tree commit diff stats
path: root/README
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
parent55e355c0a32de0bcf12f4a52ae7ac3b072f0bf66 (diff)
downloadfornax-f82aa5441c24b3c2f08b019bd2b04e02d845fa41.tar.gz
Document options
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
index 94668f8..23317dd 100644
--- a/README
+++ b/README
@@ -17,6 +17,7 @@ Table of Contents
 ..... 1. Without `git'
 ..... 2. With `git'
 3. Documentation
+.. 1. Options
 4. Project Structure
 5. Fornax Format
 .. 1. Grids
@@ -119,6 +120,14 @@ This collection includes:
     number then the slideshow might be incorrect.
 
 
+3.1 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).
+
+
 4 Project Structure
 ═══════════════════