Initial Commit

spelling-rbee is a spelling program written in ruby and reading from
.txt files.  It is licenced under the Gnu General Public licence
Version 3, or any later version, at your option.

1 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c409ead
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+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
+ruby open-uri module
+
+Useage:
+./spelling-rb <url>
+
+
+SPELLING-RBEAD
+The spelling ruby reader.
+
+spelling-rbead is the email reader for spelling-rbee.  You can use it to read your email
+for a message that begins with the line spelling and that then follows the format for spelling-rbee.
+This a way to make .txts for spelling-rbee (however it is not the only way.)
+
+Dependencies:
+ruby
+ruby net/imap
+an existing file to write to
+
+Useage:
+./spelling-rbead <server> <username> <password> <address who sent the list> <file to write to>