Read Me

-- IWS - Interactive Window System  ---------------------------------------------------------------------  


A. Configuring IWS

   Following defines under "iws_config.h" file are used to configure IWS:
     
   IWS_DEBUG_MODE  - If set to IWS_YES, debug information is printed on screen during run-time
   IWS_FULL_SCREEN - If set to IWS_YES, IWS runs full-screen
   IWS_HIDE_MOUSE  - If set to IWS_YES, IWS application hides mouse. Used for touch screens
   IWS_WIN_WIDTH   - Width of the application screen, also resolution for full screen mode
   IWS_WIN_HEIGHT  - Height of the application screen, also resolution for full screen mode
   IWS_WIN7_FIX	   - OpenCV has problems on Win7, a dirty workaround is possible if set to IWS_YES

   Following defines under "iws_config.h" file are used to point out how IWS connects MySQL Database:

   IWS_SERVER_NAME   - Server address of MySQL Database
   IWS_DB_USER	     - Username for accessing DB
   IWS_DB_USERPASS   - Password for specified username
   IWS_DB_NAME	     - Database name of IWS Application, by default used as "iws_db" 
   IWS_TABLE_CONFIG  - Configuration table name, by default used as "iws_config"
   IWS_TABLE_CATALOG - Catalog table name, by default used as "iws_catalog"
   IWS_TABLE_CART    - Cart table name, by default used as "iws_cart"



B. Compiling IWS

 - IWS is provided with its MS Visual Studio 2008 Project File, located under "IWS" folder. All required
   Header, Library and DLL files are already provided and pointed via relative paths. There is no need to
   install any other library to compile IWS Core Application.

 - IWS Administration application POS2 is also provided with its VS 2008 .NET Project file, located under
   "IWs_Admin". In order to compile and run IWS Administrator Application POS2, MySQL Connector Adaptor
   for .NET must be installed. The adaptor is available under "tools\mysql-connector-net-6.2.32.msi"



C. Debugging and Running IWS

 - IWS can be compiled for "Debug" and "Release" targets. The generated executable files will be located
   under "bin\Debug" and "bin\Release" respectively. All required DLL files are already located in these
   folders.

 - If you prefer to use DirectX as rendering base (which is asked on first run-time, via Ogre Core), you
   may need to update your Directx version. This can be done via provided file "tools\dxwebsetup.exe"

 - It is not possible to set a Working Directory for VS2008 in solution file. Therefore, in order to debug
   or run IWS via Visual Studio 2008, you need to set "Working Directory" to following value for both
   targets (Debug and Release):

        $(SolutionDir)..\bin\$(ConfigurationName)

   You may also point "bin\Debug" and "bin\Release" folder manually, using an absolute path.   

 - IWS also makes use of MySQL database. Therefore you need to start provided MySQL server before running
   IWS. You may use the provided batch files "start_mysql.bat" and "stop_mysql.bat" to control provided
   MySQL server.



D. Distributing IWS

 - If you want to run compiled IWS Program on another machine, you need to do the following;

   + Copy "bin", "media" and "mysql" folders, keeping their local hierarchy (located at same level)
   + You may also copy "start_mysql.bat" and "stop_mysql.bat" for controlling the Databse
   + Install VS2008 redistributables depending on your VS2008 version (provided under tools folder)


 - If you want to run compiled IWS Administration program on another machine, do the following;

   + Copy POS2 bin file contents to a desired target directory
   + Install MySQL adaptor for .NET on machines where you want to run IWS Administrator program POS2
     (The adaptor is available under "tools\mysql-connector-net-6.2.32.msi")
   + You may also need to edit "PoS2.exe.config" to specify a remote MysQL server, where IWS is running.