From c78971d9bffb0ce05bab658b3ef3a9ece82ca7dd Mon Sep 17 00:00:00 2001 From: Andinus Date: Wed, 20 Jan 2021 16:55:04 +0530 Subject: Document new feature (reading puzzle from file), update README README was re-generated from README.org New feature was documented. --- README | 15 ++++++++++----- README.org | 5 +++-- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README b/README index b05d0ae..8910eee 100644 --- a/README +++ b/README @@ -26,13 +26,17 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. This was recorded with `asciinema(1)'. - [https://asciinema.org/a/384464.png] + [https://asciinema.org/a/385500.png] + + ⁃ Octans v0.1.0 - finds 10 solutions to a puzzle: + + ⁃ Octans v0.1.0: ⁃ Octans 2020-01-14: ⁃ alt-link (download): -[https://asciinema.org/a/384464.png] +[https://asciinema.org/a/385500.png] 2 Documentation @@ -67,10 +71,11 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. be seperated by a newline (`\n') & sorted alphabetically. -2.2.2 url -╌╌╌╌╌╌╌╌╌ +2.2.2 path +╌╌╌╌╌╌╌╌╌╌ - The url to be passed must be in either format: + The path to be passed must be a *readable file* or an *url* in either + format: • Link when you view it from your local instance: diff --git a/README.org b/README.org index 21e5dc6..5847eb1 100644 --- a/README.org +++ b/README.org @@ -43,8 +43,9 @@ 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=) & sorted alphabetically. -*** url -The url to be passed must be in either format: +*** path +The path to be passed must be a *readable file* or an *url* in either +format: - Link when you view it from your local instance: https://tilde.zone/web/statuses/105531207939242077 -- cgit 1.4.1-2-gfad0