about summary refs log tree commit diff
path: root/mapScore.1.scd
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@librem.one>2022-06-29 21:08:19 -0400
committerZach DeCook <zachdecook@librem.one>2022-06-29 21:51:36 -0400
commit9e9cef85c03800cce37055999f25fd6220f05772 (patch)
treecf0ee2a94d1c6c732fe1c5b4925690c9f781489f /mapScore.1.scd
parentc006ba2ad828dca1d1c851bb2fbddd457fe577d9 (diff)
downloadswipeGuess-9e9cef85c03800cce37055999f25fd6220f05772.tar.gz
Documentation: Add man pages for swipeGuess and mapScore
Diffstat (limited to 'mapScore.1.scd')
-rw-r--r--mapScore.1.scd15
1 files changed, 15 insertions, 0 deletions
diff --git a/mapScore.1.scd b/mapScore.1.scd
new file mode 100644
index 0000000..8bf97b6
--- /dev/null
+++ b/mapScore.1.scd
@@ -0,0 +1,15 @@
+mapScore(1)
+
+# NAME
+mapScore - score words by path length through 2D letter map
+
+# SYNOPSIS
+
+*mapScore* _map.tsv_ [_bee_] < _words.txt_ > _scored_words.tsv_
+
+# OPTIONS
+_bee_
+	Calculates score differently by treating _map.tsv_ as a hex-grid (even lines indented halfway)
+
+# SEE ALSO
+*swipeGuess*(1)