diff options
| author | Andinus <andinus@nand.sh> | 2021-01-14 13:30:35 +0530 |
|---|---|---|
| committer | Andinus <andinus@nand.sh> | 2021-01-14 13:30:35 +0530 |
| commit | b6ef7925408eb1354b7757c38707cfd3a3313b4f (patch) | |
| tree | e4f3143ff6c9919dfe45eb6846b2de96789af5d7 /README.org | |
| download | octans-b6ef7925408eb1354b7757c38707cfd3a3313b4f.tar.gz | |
Initial commit
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 22 |
1 files changed, 22 insertions, 0 deletions
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. |