From b6ef7925408eb1354b7757c38707cfd3a3313b4f Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Thu, 14 Jan 2021 13:30:35 +0530
Subject: Initial commit

---
 README.org | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..8931409
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+#+SETUPFILE: ~/.emacs.d/org-templates/projects.org
+#+EXPORT_FILE_NAME: index
+#+OPTIONS: toc:2
+#+TITLE: Octans
+
+Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
+
+* Documentation
+The url to be passed must be in either format:
+
+- https://tilde.zone/web/statuses/105531207939242077
+  Link when you view it from your local instance.
+
+- https://mastodon.art/@Algot/105333136907848390
+  Link from Algot's profile.
+** Options
+*** dict
+Octans's default dictionary file is =/usr/share/dict/words=, use =--dict=
+flag to change the dictionary. The words in dictionary must be seperated
+by a newline (=\n=).
+*** verbose
+This will increase verbosity.
-- 
cgit 1.4.1-2-gfad0