about summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-11-17 23:14:44 +0530
committerAndinus <andinus@nand.sh>2021-11-17 23:14:44 +0530
commit71ff6400dc3aef9ceb6c71f0d102f5b9ff40bab8 (patch)
tree04d6657812e4b4682df35e65283970f6110d4c0c /README.org
parent428fa000256bd47c121f8b03b94f37e9f29095e0 (diff)
downloadfornax-71ff6400dc3aef9ceb6c71f0d102f5b9ff40bab8.tar.gz
Add usage instructions
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
index 5f580e8..f182f03 100644
--- a/README.org
+++ b/README.org
@@ -33,6 +33,16 @@ Fornax v0.1.0:
 - DFS-51-incomplete (upto 4,000 frames; 120 fps):
   https://diode.zone/w/hWWaw8uKHCP5weUP5WWArD
 
+* Usage
+
+#+begin_src sh
+# Solve the maze.
+raku algorithms/raku/DFS.raku resources/input/06 > /tmp/solution.fornax
+
+# Visualize the solution.
+raku -Ilib bin/fornax /tmp/solution.fornax
+#+end_src
+
 * Installation
 
 ~fornax~ is written in Raku, it can be installed with ~zef~. You can also