Update of the installation section in the README file.
authorkrzsas <krzsas@gmail.com>
Wed, 6 Sep 2006 07:51:32 +0000 (07:51 +0000)
committerkrzsas <krzsas@gmail.com>
Wed, 6 Sep 2006 07:51:32 +0000 (07:51 +0000)
git-svn-id: file:///svnroot/mdictionary/trunk@6 5bde0345-f819-0410-ac75-e5045f9217cc

README
dbus/Doxyfile

diff --git a/README b/README
index 6e65fd7..10cfc58 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-WhiteStork Multilingual Dictionary
+WhiteStork Multilingual Dictionary ver. 0.1.0 ALPHA
+
 What is WhiteStork Multilingual Dictionary
 ------------------------------------------
 WhiteStork is a multilingual dictionary enabling its users to use many dictionary formats. Our final goal is to use many search engines so that different file formats could be used. They will be in a form of dynamically loadable modules. For now however, we have limited the project to one engine for the XDXF format. The application consists of four modules: 
@@ -16,24 +16,26 @@ In order to compile this application go to the WhiteStork/trunk directory and ru
 
 make clean && make
 
-Should there be any problems, please contact one of our developers.
+However, it is important to put out, that this will only compile the program. You won't be able to run it. Read the Installation section for information on how to install WhiteStork on your system.
 
-Running
--------
+Installation
+------------
 
-After the compilation is successful run the following command:
+In order to install the program, issue the following command:
 
-make run
+make deb && make debi
 
-If an error dialog pops up, saying that: "There is no dictionary available", this means you have to download a dictionary. In order to do that go to: http://xdxf.revdanica.com/down/. Place the dict.xdxf file in WhiteStork/trunk folder. When switching to a different dictionary, please remove the dict.cache file.
+These lines, compile the source code, create a debian package and install it onto your system.
+
+Running
+-------
 
-Making a deb package
---------------------
+After installation is successful, there should a WhiteStork entry in the Extras submenu. All you have to do now is start it. Please refer to the WhiteStork User Interface Specification for hints on how to use our dictionary. It is available under this URL: https://garage.maemo.org/docman/?group_id=58
+The package contains two dictionaries, so you can start using our app right away.
 
-We have also included an additional target named "deb" to our Makefile. So if you would like to make a debian package from a current release, knock yourself out. Type the following command in the shell:
+Should there be any problems, please contact one of our developers via garage.maemo.org.
 
-make deb
 
 Have fun using our application
 
-The WhiteStork Multilingual dictionary developer's
+The WhiteStork Multilingual dictionary developer's
\ No newline at end of file
index fc998bf..9e66859 100644 (file)
@@ -459,7 +459,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
  
-INPUT                  = src/ws_dbus.c ../include/ws_dbus.h
+INPUT                  = ../include/ws_dbus.h
  
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp