diff options
| author | Andinus <andinus@nand.sh> | 2021-11-03 23:07:19 +0530 |
|---|---|---|
| committer | Andinus <andinus@nand.sh> | 2021-11-03 23:07:19 +0530 |
| commit | f82aa5441c24b3c2f08b019bd2b04e02d845fa41 (patch) | |
| tree | 328d24c45ad4a4a9d751c58f5546c2819a0cba25 | |
| parent | 55e355c0a32de0bcf12f4a52ae7ac3b072f0bf66 (diff) | |
| download | fornax-f82aa5441c24b3c2f08b019bd2b04e02d845fa41.tar.gz | |
Document options
| -rw-r--r-- | README | 9 | ||||
| -rw-r--r-- | README.org | 6 |
2 files changed, 15 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 ═══════════════════ 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 |