summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorSimon Parri <simonparri@ganzeria.com>2020-09-18 11:15:06 -0500
committerSimon Parri <simonparri@ganzeria.com>2020-09-18 11:15:06 -0500
commitb4f1ff32e0025a677b41f36446d7fbcbb5c183b0 (patch)
treea22d71af27ea3733866ae4f153735490d9b0c001 /README.org
parent25fc6b9e6a59eba9501fa3d3e1b87ba6a5027512 (diff)
downloadspelling-rbee-b4f1ff32e0025a677b41f36446d7fbcbb5c183b0.tar.gz
spelling-rbee-b4f1ff32e0025a677b41f36446d7fbcbb5c183b0.zip
Turn README into README.org and update it
Diffstat (limited to 'README.org')
-rw-r--r--README.org26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c2a6ada
--- /dev/null
+++ b/README.org
@@ -0,0 +1,26 @@
+* spelling-rbee
+The spelling bee in ruby.
+
+~spelling-rbee~ is a spelling bee program that can be used with any
+~.txt~ file that follows the format of one thing to spell per each
+line. (Note that you can have more than one word per line, you just
+have to type the whole line.)
+
+Dependencies:
++ espeak
++ ruby
+
+Usage:
+~./spelling-rbee <url-or-file>~
+* spelling-rbead
+The spelling ruby reader.
+
+spelling-rbead is the email reader for spelling-rbee. It to reads
+your email for a message that has the word "Spelling:" in the subject
+and outputs the contents.
+
+Dependencies:
++ ruby
+
+Usage:
+See ~spelling-rbead --help~