Initial mirror commitHEADmaster

1 files changed, 74 insertions, 0 deletions

diff --git a/releases/README b/releases/README
new file mode 100644
index 0000000..86f6223
--- /dev/null
+++ b/releases/README
@@ -0,0 +1,74 @@
+FRESH MEMORY
+http://freshmemory.sourceforge.net
+
+Fresh Memory is an application that helps to learn large amounts of any material with Spaced Repetition method. The most important subject is learning foreign words, but Fresh Memory can be also used to learn anything else. Other examples are country's capitals and flags, chemical elements, mathematical formulas, technical terms. The learning data is stored as flash cards and dictionaries: sets of cards. The flash cards may have several fields, and the user controls what combination of fields to learn. The flashcards can have formatted text and images. The look of flash cards and studying parameters are can be flexibly adjusted.
+
+FEATURES
+=============================
+
+* Efficient Spaced Repetition method as well as simple review of flash cards (Word drill)
+* Flashcards are groupped into dictionaries, which are stored in separate files
+* Import and export dictionaries from/to CSV files
+* Shows studying statistics: studied and scheduled cards for different periods, total new cards left.
+* Rich formatting of cards: colors, fonts and images
+* Images can be added with graphical user interface
+* Multi-sided flashcards. Dictionary records may have several fields.
+* Studying cards with different directions. Card fields are defined in card packs.
+* Cards with the same question are automatically merged into one card
+* Cards with several questions (separated with ';') are automatically broken down to several cards
+* Undo feature: all dictionary modifications can be undone
+* Editing and removing cards directly from the study view
+* Card fields may have different styles: font and color
+* Adjustable card background color and fonts
+* Automatic highlight of question keywords in the examples
+* Adjustable study parameters: random or sequential card show, different day limits
+* Adjustable day start: e.g. at 3 o'clock.
+* Full support of Unicode (UTF-8): any international characters can be used.
+* Dictionary and the study data are stored in separate files. It is easy to share clean dictionaries.
+* Translations: Czech, English, Finnish, French, Russian, Spanish, Ukrainian
+
+       
+COMPILATION
+=============================
+
+Commands:
+    qmake
+    make
+    sudo make install
+
+See README file for details.
+
+   
+USAGE
+============================
+
+freshmemory [OPTIONS] [DICTIONARY]
+
+Argument:
+    DICTIONARY  - a dictionary filename to be loaded.
+
+Options:
+    --version, -v       Prints version information and quits.
+    --help, -h          Prints help page and quits.
+
+Dictionary files use .fmd extension. You can bind this extension to Fresh Memory for easy opening of your dictionaries.
+    
+On Windows, output to console is possible only in the debug version. Compile it with:
+    make debug
+
+The user's study data (.fms files) is saved to the same directory as the dictionary.
+
+Changed settings are saved to user-specific application data directory:
+    * Linux and MacOS:
+        ~/.config/freshmemory/
+    * Windows:
+        %APPDATA%\freshmemory\
+    * Windows XP:
+        C:\Documents and Settings\<User>\Application data\freshmemory\
+    * Windows 7:
+        C:\Users\<User>\AppData\Roaming\freshmemory\
+
+Image paths in the dictionary records can be specified relative to the dictionary path:
+    - <img src="%/image.png">   # In the same directory as the dictionary
+    - <img src="%%/image.png">   # In <Dictionary dir>/<Dictionary file name without extension>/
+    - It is safe to move dictionary with its images to another place or computer.