====================================================

                 gNaXEL Read Me

====================================================

Thanks to the folks at Mozilla (Mozilla.org) for providing an easy-to-follow template for this readme file.

gNaXEL is subject to the terms detailed in the license agreement accompanying it.

This ReadMe file contains information about system requirements and installation instructions for the Linux builds of gNaXEL. 

For more info on gNaXEL, see artige.com/XMLeditor.htm. There is no provision to submit bugs or other feedback until the project is migrated to SourceForge.


====================================================

                 Getting gNaXEL

====================================================

You can download the latest build of gNaXEL from the artige.com/XMLeditor.htm web page.

Be sure to read the gNaXEL release notes for information on known problems and installation issues with gNaXEL.  The release notes can be found at the same web page, along with the releases themselves.


====================================================

               System Prerequisites

====================================================
  
- We ran the editor on Fedora Core 1 Linux
  * No reason why any other Red Hat or other Linux distro would not work either
- The following library versions (or compatible) are required, especially their libraries:
  - Java (we used Sun J2SE version 1.4.2)
  - Eclipse IDE (we used version 3.0.0)
  	  	  * would be helpful just to get the correct SWT libraries installed
  - Apache Xerces Java Parser 2.6.2 Release
  	  	  * Do not use Release 2.6.1, had CDATA / Entity Reference bug!
-Intel Pentium-class 233 MHz (or faster) processor
-64MB RAM
-2MB free hard disk space


====================================================

            Installation Instructions

====================================================

Note that the installation is completely manual.  No automated scripts have been written yet.

Install into a clean (new) directory.  Installing on top of a previous identical release build may cause problems.

Note: These instructions do not tell you how to build gNaXEL.  Those instructions have not yet been written.

Note: These instructions do not tell you how to operate gNaXEL.  Those instructions have not yet been written either.


Installation Instructions
-------------------------------

Note: If you install in the default directory (which is usually /usr/local/artige), or any other directory where only the root user normally has write-access, you must install the program using root privileges (ie: su).


To install gNaXEL by downloading the zip file:

1. Make sure the /usr/local directory already exists.

2. Add the /usr/local/artige directory if it does not already exist (mkdir /usr/local/artige) and change to that directory (cd /usr/local/artige).

3. Click the appropriate release link from the artige.com/XMLeditor.htm page to download the release package (gNaXEL*.zip) file into the artige directory.

4. Change to the Artige directory (cd /usr/local/artige) and decompress the file with the following command:

  unzip gNaXEL*.zip
	
This creates a "gNaXEL" directory under your artige directory, sorted by release number

4. Change to the gNaXEL directory (cd /usr/local/artige/gNaXEL-0.nn). 

5. You will probably need to edit the run script so it can locate the libraries and jar files on your system.  Locate the variable names at the top of the gNaXEL.sh file with your text editor and modify the library path to reflect their location on your system.

6. Run gNaXEL with the following run script: 

  ./gNaXEL.sh


To hook up gNaXEL complete with icon to the GNOME Panel, follow these steps:

1. Click the GNOME Main Menu button, open the Panel menu, and then open the Add to Panel submenu and choose Launcher.

2. Right-click the icon for gNaXEL on the Panel and enter the following command:
  directory_name./gNaXEL.sh

where directory_name is the name of the complete directory path you unzipped gNaXEL into. For example, the default directory that Artige suggests is /usr/local/artige/gnaxel-0.nn, where nn was the release number.

3. Type in a name for the icon, and type in a comment if you wish, such as "Graphical XML editor".

4. Click the icon button and type in the following as the icon's location:

  directory_name/icons/gNaXEL50.xpm

where directory name is the directory where you installed gNaXEL. For example, the default directory is /usr/local/artige/gnaxel-0.nn/icons/gNaXEL50.xpm, where nn was the release number.