How to Compile GUF

Getting the Tools

Windows Users

For Windows, GUF uses MinGW as its compiler. For your convenience, I have put together a package which makes this easy to install (if you already have MinGW installed, please read this). Just download the following file:

http://guf.sourceforge.net/MinGW-1.1-guf.zip

Now, unzip that and put it anywhere. (For these instructions, I will assume you unzipped to C:\, so you should have the directory C:\mingw which contains everything. You can install anywhere you like, though.)

The only thing you have to do is add MinGW's bin directory to your path. This allows you to run MinGW from the command-line. The way to do this depends on your version of Windows:

  • Windows 95/98/ME: Edit C:\autoexec.bat with a text editor. Add the following line to the end of the file:

    PATH C:\mingw\bin;%PATH%

    Then, reboot. Note that I highly recommend that you upgrade to Windows 2000 as soon as possible, as you'll find it much easier to use the command line under 2k. (Furthermore, as of this writing, GUF does not run under any version of Windows other than 2000 and XP.)

  • Windows NT/2000/XP: Right-click on "My Computer" and click "properties". Click the "advanced" tab, click on "environment variables", and find the variable "PATH". Add "C:\mingw\bin;" (without the quotes) to the beginning of this variable.

Now, open the DOS prompt and type "gcc -v". If it works, you have installed MinGW successfully.

For your convenience, I have included GufBuild and the command-line version of WinCVS in this package, so you will not need to download those yourself. The source code for MinGW and all components is available at http://www.mingw.org. The source code for WinCVS and all components is available at http://www.cvsgui.org. The source for GufBuild can be downloaded at the downloads page. A small but essential bug fix for MinGW (which is included in the above patch) can be found here. All of these programs are licensed under the GNU General Public License.

Other OS's

For other OS's, you first have to install GCC and the associated tools. On MacOSX, these are found on the Developer Tools CD. On Linux, BeOS, and most open-source systems, GCC probably came with the OS. On any other system, you're on your own. You will also need CVS, which is pretty much the same story (if you have GCC, you probably have CVS).

To install GufBuild, you must download and compile the source. Get the code from the downloads page. Instructions for compiling are in the file "INSTALL.txt" within the GufBuild package.

Compiling GUF

Download the GUF sources. See the downloads page for info on how you might do this.

Now, to compile GUF, cd to the GUF directory and type "gufbuild" at the prompt. Alternatively, Windows users can simply double-click on the file "build.bat" in the GUF folder.

Installing GUF

Windows users can ignore this seciton.

Anyone else needs to install GUF by copying the GUF library to your library directory. So, assuming you are still in the GUF directory, just type the following:

cp lib/libguf.so /usr/lib

You may have too be the root user to do this. Depending on your OS, you may also have to run "ldconfig" as root to update the shared library database.

Running GUF tests

Once GUF is compiled and installed, you can run some tests on it by running the program "guftest" found in the "bin" directory within the guf directory.

Editing the source

If you just want to edit files that already exist, you can do so fairly easily. Just edit the file and re-run GufBuild to build it in.

If you want to add new files or directories, you will have to learn how to use GufBuild. See the documentation for GufBuild for more information. All you have to do, though, is edit the *.gbld files, which should be fairly self-explanitory.