1. Getting Started

1.1. Installing GWHAT on a Windows system

First of all, the latest binary distribution of GWHAT, packaged as a zip archive, must be downloaded from the project Releases [1] page on GitHub. Then the content of the zip archive needs to be extracted in a directory with Write [2] permission. This will result in a directory containing a folder named GWHAT, which contains several files including a file named gwhat.exe. GWHAT can then be started simply by double clicking on this file, no installation is required.

The installation directory will also contain a folder named Projects, where all input and output files used and created by GWHAT are stored by default. This folder includes a project example with samples of input and output files to test and learn the various features of the program.

Note

Please help GWHAT by reporting bugs or proposing new features in our Issues Tracker [3] on GitHub.

1.2. Updating GWHAT on a Windows system

It is possible to check if updates are available for GWHAT by clicking on the button Check for Updates in the About GWHAT window, which can be accessed by clicking on the stop icon as shown in Fig. 1.1.

alternate text

Fig. 1.1 Presentation of the tool to check if updates are available for GWHAT.

To update GWHAT to a newer version, the latest binary distribution of the software, packaged as a zip archive, needs first to be downloaded from the project Releases page on GitHub. Then, in the directory where GWHAT was installed, the folder named GWHAT needs to be replaced manually with the one that is included in the zip archive that was just downloaded. The new version of GWHAT can then be started simply by clicking on the gwhat.exe, located in the new GWHAT folder.

1.3. Running GWHAT from the source files

Binary distribution are currently produced only for Windows systems. However, GWHAT can run on Windows, Linux, or macOS computer operating systems directly from the source files.

Footnotes

[1]https://github.com/jnsebgosselin/gwhat/releases/latest
[2]Permits adding of files and subfolders (https://msdn.microsoft.com/en-us/library/bb727008.aspx).
[3]https://github.com/jnsebgosselin/gwhat/issues