How to install Wandora

From WandoraWiki
(Difference between revisions)
Jump to: navigation, search
(Wandora's bat scripts)
(Epilogue)
Line 19: Line 19:
 
After successful installation you should check all required Java libraries locate in '''build/lib''' directory. Wandora works fine with enclosed libraries. If you are planning to use database topic maps or some other advanced features of Wandora you may require additional Java libraries. [[Download]] page lists required and optional libraries.
 
After successful installation you should check all required Java libraries locate in '''build/lib''' directory. Wandora works fine with enclosed libraries. If you are planning to use database topic maps or some other advanced features of Wandora you may require additional Java libraries. [[Download]] page lists required and optional libraries.
  
Finally you are ready to run Wandora application. Double click '''Wandora.exe'''. Executable simply runs '''bin/wandora.bat''' without console window.
+
Finally you are ready to run Wandora application. If your operating system in Windows double click '''Wandora.exe'''. Executable simply runs '''bin/wandora.bat''' without console window. If you prefer Linux or Unix (including Mac) as your operating system, browse shell scripts in '''bin''' and choose the script for your memory footprint.
  
 
To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you to take a look at the [[Quickstart]]. Tutorials and manuals are [[Tutorials|here]].
 
To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you to take a look at the [[Quickstart]]. Tutorials and manuals are [[Tutorials|here]].
  
=== Wandora's bat scripts ===
+
=== Wandora's shell scripts ===
  
Of course you may launch Wandora directly with bat scripts found in '''bin'''. Script execution keeps the console window open and is useful if you encounter problems running the application or need to adjust the Java environment of application. By default the '''bin''' contains five scripts
+
Of course you may launch Wandora directly with startup scripts found in '''bin'''. Script execution keeps the console window open and is useful if you encounter problems running the application or need to adjust the Java environment of application. By default the '''bin''' contains five '''bat'' and '''sh''' scripts. '''Bat''' scripts are for Windows based operating systems while '''sh''' scripts are used in Linux and Unix type platforms.
  
* '''SetClasspath.bat''' contains all classpath settings of Wandora.
+
* '''SetClasspath''' contains all classpath settings of Wandora.
* '''Wandora.bat''' is the default script executed by '''Wandora.exe'''. Script sets JRE's memory to 750M.
+
* '''Wandora''' sets JRE's memory to 750M. '''Wandora.exe''' launches '''wandora.bat''' without console window.  
* '''Wandora-mini.bat''' sets JRE's memory to 256M.
+
* '''Wandora-mini''' sets JRE's memory to 256M.
* '''Wandora-large.bat''' sets JRE's memory to 1G.
+
* '''Wandora-large''' sets JRE's memory to 1G.
* '''Wandora-huge.bat''' sets JRE's memory to 1.5G.
+
* '''Wandora-huge''' sets JRE's memory to 1.5G.
  
If your operating system is not Windows you may need to customize scripts before successful execution of Wandora is possible.
+
If your operating system is not Windows or Linux or Unix you may need to customize scripts before successful execution of Wandora is possible.
  
 
==Uninstalling Wandora==
 
==Uninstalling Wandora==
  
 
Wandora has no uninstaller at the moment. As Wandora does not store files outside the Wandora folder, removing the folder uninstalls the Wandora application.
 
Wandora has no uninstaller at the moment. As Wandora does not store files outside the Wandora folder, removing the folder uninstalls the Wandora application.

Revision as of 17:55, 17 October 2007

Contents

Before installation

Before installing Wandora you should ensure that you have Java Runtime Environment (JRE) 6.0 installed. You should also download Wandora software package before proceeding. See also system requirements before installing Wandora.

Installation

Current version of Wandora has no guided installation procedure or installation wizard found in many commercial software packages. Wandora is installed simply extracting Wandora software package into a desired location on your computer. Installation steps are

  • Choose location where to install Wandora
  • Unzip Wandora.zip package in the location

After successful unzip you should see a folder like this:


Wandora folder.gif

Epilogue

After successful installation you should check all required Java libraries locate in build/lib directory. Wandora works fine with enclosed libraries. If you are planning to use database topic maps or some other advanced features of Wandora you may require additional Java libraries. Download page lists required and optional libraries.

Finally you are ready to run Wandora application. If your operating system in Windows double click Wandora.exe. Executable simply runs bin/wandora.bat without console window. If you prefer Linux or Unix (including Mac) as your operating system, browse shell scripts in bin and choose the script for your memory footprint.

To get your hands dirty you might want to try example projects found in samples folder. If you are not familiar with the Wandora I suggest you to take a look at the Quickstart. Tutorials and manuals are here.

Wandora's shell scripts

Of course you may launch Wandora directly with startup scripts found in bin'. Script execution keeps the console window open and is useful if you encounter problems running the application or need to adjust the Java environment of application. By default the bin contains five bat and sh scripts. Bat scripts are for Windows based operating systems while sh scripts are used in Linux and Unix type platforms.

  • SetClasspath contains all classpath settings of Wandora.
  • Wandora sets JRE's memory to 750M. Wandora.exe launches wandora.bat without console window.
  • Wandora-mini sets JRE's memory to 256M.
  • Wandora-large sets JRE's memory to 1G.
  • Wandora-huge sets JRE's memory to 1.5G.

If your operating system is not Windows or Linux or Unix you may need to customize scripts before successful execution of Wandora is possible.

Uninstalling Wandora

Wandora has no uninstaller at the moment. As Wandora does not store files outside the Wandora folder, removing the folder uninstalls the Wandora application.

Personal tools