I What is Teachmar?
~~~~~~~~~~~~~~~~~~~~~~
Teachmar is a program that helps learning foreign words and phrases.
II Features
~~~~~~~~~~~~~
- simple database file; everything is plain text,
- simple and fast interface,
- unique asking algorithm - the better you remember a word,
the less frequently it is asked for,
- basic terminal-based interface works almost everywhere,
- installs only 2 files: an executable and a license information
III Requirements and installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For further information on installing Teachmar, see INSTALL.
IV Usage
~~~~~~~~~~
For example:
1. Add 20 new words
2. Test yourself everyday
3. Some day Teachmar will not ask you for any word; you smile and go back
to the point 1
To add new words:
1. run $ teachmar -a
2. type in native and foreign spelling of the word, both followed by
Enter,
3. optionally type in pronunciation of the word (or any other comment
displayed after unsuccessful answer) - if you wish to omit this simply
hit Enter,
4. if you want to continue go to point 2; hit Enter to finish
To test yourself:
1. run $ teachmar
2. you will see some information, hit Enter to start,
3. type in foreign spelling if you see your native spelling of some
word and vice versa; repeat until the program quits.
V Managing the database
~~~~~~~~~~~~~~~~~~~~~~~~~~
You will probably hardly ever want to edit your database since it is
automatically maintained by Teachmar. However, in certain situations you
would like to. You can do that with your favourite text editor due to fact
that the whole database is a single text file (located in home directory
and named ~/.teachmar by default). Each record is one line; pipe character
(|) is a field separator.
Remember not to edit a database when Teachmar is running with the same file!
VI Bugs & suggestions
~~~~~~~~~~~~~~~~~~~~~~~
Please report bugs to <smiszym@gmail.com>. When reporting a bug, provide
all information that may be helpful to diagnosis, including version of
Teachmar, output of commands and package which you installed from (or, if you
built from sources, version of the compiler).
You are also encouraged to submit suggestions about functionality or about
the code.
VII Authors
~~~~~~~~~~~~
- Marcin Szymański <umaszym@gmail.com>
- Michał Szymański <smiszym@gmail.com>
