Autotools supportHEADmaster

1 files changed, 42 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..7b2eebc
--- /dev/null
+++ b/README
@@ -0,0 +1,42 @@
+Introduction
+============
+
+WOrdExtract is a program to pick up list of unique words
+from any plain text or .srt file. Some words can be excluded
+according to words in Your dictionary
+
+Compilation
+===========
+
+To compile this package You should have
+
+    gtk+-2.0 >= 2.12.0
+
+The latest version of GTK+ can be found at http://ftp.gnome.org
+Executive summary:
+
+    ./configure
+    make
+    make install
+
+Running
+=======
+
+YOu can run application simply by typing 
+
+    $wordextract
+
+Before you can add words to your dictionary and/or process
+files you want. Also you can savw processed text or/and 
+list of words (words saving options can be found in 
+Preferences manu item). After installation You also  can
+maintain basic dictionary which is in project root directory
+by commands (assuming you are in project root dir)
+
+    $mkdir ~/.wordextract (*)
+    $cp dict ~/.wordextract/
+
+* Note, that .wordextract directory will be created
+at first run so, you maybe don't need to create it
+
+Enjoy!
\ No newline at end of file