1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.en	Sat Nov 12 14:03:54 2011 +0100
     1.3 @@ -0,0 +1,93 @@
     1.4 +
     1.5 +'''new-words''' is a script which helps you to control your vocabulary
     1.6 +and find unknown words in texts before you start to read them.
     1.7 +
     1.8 +The script is intended to be run in a console; interactive part of the work
     1.9 +done with a help of a text editor (vim by default).
    1.10 +
    1.11 +Features:
    1.12 +* Multilanguage support;
    1.13 +* Dictionary software integration;
    1.14 +* Notes to unknown words.
    1.15 +
    1.16 +== Installation ==
    1.17 +
    1.18 +    wget http://xgu.ru/downloads/new-words.tar.gz
    1.19 +    tar xvfz new-words.tar.gz
    1.20 +    ./INSTALL
    1.21 +
    1.22 +== First steps ==
    1.23 +
    1.24 +First of all you have to give a program some information
    1.25 +about your vocabularies for foreign languages (one or more).
    1.26 +Let us learn Russian and French.
    1.27 +
    1.28 +Find unknown words in a page from the Internet:
    1.29 +
    1.30 +    $ new-words http://ru.wikipedia.org/wiki/Москва
    1.31 +
    1.32 +Delete (dd) words, that you know. Save the result and quit the editor (:wq).
    1.33 +
    1.34 +Repeat the same using several other pages:
    1.35 +
    1.36 +    $ new-words http://ru.wikipedia.org/wiki/Киев
    1.37 +    $ new-words http://ru.wikipedia.org/wiki/Linux
    1.38 +
    1.39 +Now new-words knows something about your Russian vocabulary.
    1.40 +
    1.41 +You can do the same for other languages, e.g. for French:
    1.42 +
    1.43 +    $ new-words http://fr.wikipedia.org/wiki/Paris
    1.44 +    $ new-words http://fr.wikipedia.org/wiki/Linux
    1.45 +
    1.46 +You can change your vocabularies data in the directory ~/.new-words:
    1.47 +
    1.48 +    $ ls -1 /home/igor/.new-words
    1.49 +    fr.txt
    1.50 +    ru.txt
    1.51 +
    1.52 +The language of pages are automatically derived from URL for pages from Wikipedia.
    1.53 +If you want, you can specify language manually (using -l key):
    1.54 +
    1.55 +    $ new-words -l fr http://fr.wikipedia.org/wiki/Paris
    1.56 +
    1.57 +== External dictionaries usage ==
    1.58 +
    1.59 +There is a script ~/bin/en was created during installation.
    1.60 +
    1.61 +This is an example of the script, which translates its command line parameters from one language to another.
    1.62 +This example translates its arguments from English to Russian,
    1.63 +but you can specify another dictionary in its code.
    1.64 +
    1.65 +Also you can create links to the file to make it possible
    1.66 +to use external dictionaries not only for English texts (en)
    1.67 +but for texts in any other languages.
    1.68 +
    1.69 +    $ cd ~/bin/
    1.70 +    $ ln en fr
    1.71 +    $ ln en ru
    1.72 +
    1.73 +After that you should edit the file ~/bin/en and specify correct names of the dictionaries that have to be used
    1.74 +to translate from the French and Russian language to the language you want.
    1.75 +
    1.76 +You can use the dictionary wrapper from new-words:
    1.77 +when you are in the editor working with your words, 
    1.78 +you can set a cursor at any word and press K (shift k).
    1.79 +The dictionary wrapper will be run. 
    1.80 +
    1.81 +The wrappers' buffer will show you not only a translation of the word
    1.82 +but sentences from the text which contain the word where the cursor were.
    1.83 +
    1.84 +
    1.85 +== Adding notes to the words ==
    1.86 +
    1.87 +You can add additional notes to words which you can't remember.
    1.88 +These notes will be automatically saved and restored when needed.
    1.89 +
    1.90 +Notes are saved in the file ~/.new-words/notes-??.txt .
    1.91 +Here the language code should be specified instead of ?? .
    1.92 +
    1.93 +You can browse last notes with UNIX tail command:
    1.94 +
    1.95 +    $ tail ~/.new-words/notes-ru.txt
    1.96 +