Installation Instructions

Grism can be made to run under Linux/UNIX or Windows. The following directions show you how to get it up and running on your platform of choice.

Debian/Ubuntu

You can install Grism's dependencies via this command:

% sudo apt-get install ruby libglade2-ruby libcairo2 libgtk2-ruby
  

You can install Grism on a Debian/Ubuntu (>=7.10 recommended) system via the .deb file available on the download page. Once you have the .deb file on your system, use the following command to install it.

% sudo dpkg -i /path/to/deb-file/grism_0.9.0-1_all.deb
  

Grism is now availabe from the command line as /usr/bin/grism or from the Applications menu under 'Office'.


Windows Installer and Executable

Coming Soon!


Installation from Source

Prerequisites and Dependencies

Grism depends on a number of open source tools and libraries. The following is a list of those tools and libraries required by the latest version of Grism. See the platform specific installation instructions for more details.

The following external Ruby modules are distributed with Grism and do not need to be installed separately.

Supported Platforms




Linux/UNIX

It is left as an exercise for the reader to ensure (and complete if necessary) the installation of the above mentioned dependencies. Here are a few tips to get you started.

Once the prerequisites are installed, installing Grism under Linux/UNIX is as simple as:

% tar xvzf grism-<version>.tar.gz
% cd grism-<version>
# ruby setup.rb
  

You may also be interested in the on-line documentation for setup.rb.

Note on Linux/UNIX Configuration File Location

Configuration files on Linux/UNIX are stored in a directory named .grism in the user's home directory (ex. /home/username/.grism).




Windows

If you are upgrading from a previous Grism version, skip down to the Grism Installation section below.

If this is the first time you are installing Grism, you will need to install all of the prerequisite dependencies first. Windows machines generally don't have these dependencies already installed. If you already do have them installed, you can skip down to the Grism Installation section below. Otherwise, follow the steps directly below to bring your machine up to speed with the required dependencies.

NOTE: I'm not a Windows user so any suggestions you have for this section will be most appreciated.

Note: The Windows version of Grism has only been tested with the exact versions of the prerequisite dependency software linked below.

Prerequisite Dependency Installation

  1. Ruby - Use the One-Click Ruby Installer Project to install the Ruby programming language.
    1. Download the following version of the One-Click Installer for Windows:
    2. Save this file in your MyDocuments directory.
    3. Go to the MyDocuments directory and double-click on this file.
    4. When it asks you for a directory to use for the installation, I suggest using C:\grism\ruby. Creating a special C:\grism directory for the installation of all of Grism's dependencies prevents clutter your machine. You can, however, choose whatever directory you like. By default the installer will use C:\ruby.
  2. GTK2 - Use the win32 runtime from GLADE For Windows to install the GTK graphical user interface toolkit.
    1. Download the following version of the gtk+-win32-runtime using the link below:
    2. Save this file in your MyDocuments directory.
    3. Go to the MyDocuments directory and double-click on this file.
    4. When it asks you for a directory to use for the installation, I suggest using C:\grism\Gtk. You can, of course, use whatever directory you like. By default the installer will use C:\Gtk.
  3. ruby-gtk2 and ruby-glade2 - Use the precompiled binaries of ruby-gtk2 to install the Ruby language bindings for GTK.
    1. Download the precompiled binaries from the ruby-gnome2 download page. The file to download is:
    2. Save this file in your MyDocuments directory.
    3. Go to the MyDocuments directory and double-click on this file. WinZip should load the file. If you don't have WinZip, you can get it from here.
    4. Extract the files onto your machine. I suggest you extract them into the C:\grism directory, but you are free to choose whatever directory you like. This will create a sub-directory called something like ruby-gtk-<version> in the directory you choose.
    5. Go into this directory and double-click on the install.rb file.

Grism Installation

Once you have the 3 dependencies installed, you are ready to download and install Grism.

  1. Download the latest version of Grism from the download page.
  2. Save this file to your MyDocuments directory.
  3. Note: The file you downloaded should be named grism-<version>.tar.gz. If it does not end with the .tar.gz suffix, you should rename it be so it does end with .tar.gz. If it does not have this suffix, WinZip will not be able to read and unpack it properly.

  4. Go to the MyDocuments directory and double-click on this file. WinZip should load the file. If you don't have WinZip, you can get it from here.
  5. Extract the files onto your machine. I suggest you extract them into the C:\grism directory, but you are free to choose whatever directory you like. This will create a sub-directory called something like grism-<version> in the directory you choose.
  6. Go into this directory and double-click on the install.bat file.
  7. The installation is complete. The executable is called grism.rbw and is in the Ruby bin directory (if you used the suggested C:\grism directory to install the dependencies, it should be C:\grism\ruby\bin\grism.rbw). Double click on this file and away you go!

Note on Windows Configuration File Location

Configuration files on Windows are stored in a directory named GRISM in the user's profile directory (ex. C:\Documents and Settings\UserName\GRISM).