Differences between revisions 1 and 2
Revision 1 as of 2011-08-03 16:12:37
Size: 4980
Editor: dz
Comment:
Revision 2 as of 2015-12-08 08:49:56
Size: 4993
Editor: dz
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
#acl All:read

Jota is a written in the Ruby programming language and uses GTK+ Widgets.

Before you can install Jota you must install the Ruby programming language
and the GTK+ widget set.

You need:

 - The Ruby language: compiler, runtime, libraries
 - Gem: The Ruby package manager. Sometimes included in the Ruby package
 - Build tools (optional): If you want to install the GTK+ bindings with Ruby's
   package manager 'gem', you need the so called build tools, like 
   C-compiler, linker, make-tools, and so on. The build tools are needed,
   because the system dependent parts of the GTK+ gem are compiled during
   installation.
 - GTK+: The graphics library and widget set, known from Gnome and Gimp
 - GTK+ Bindings for Ruby: A library so that you can access GTK+ from Ruby
 - Jota: Finally Jota itself. This is also a Ruby gem.


INSTALLING
==========

For the most common operating systems the steps are as follows:

Ubuntu/Debian Linux
-------------------
(Tested with Ubuntu 11.04 and Debian 6.0 (squeeze))

Install Ruby + Gems:
  apt-get install ruby rubygems

Install GTK+ + Ruby bindings:
  apt-get install libgtk2-ruby          # (recommended)
or
  apt-get install build-essential    
  gem install gtk2
  
Install Jota:
  gem install jota                      # (recommended)
or
  Download a jota-VER.gem from http://rubygems.org/gems/jota. VER stand
  for the version you are looking for.
  gem install jota-VER.gem

Call Jota:
or
  /var/lib/gems/1.8/bin/jota
or
  Append the line
    PATH="$PATH:/var/lib/gems/1.8/bin"
  to $HOME/.bashrc (or consult your shell's manpage for the correct file
  and/or syntax)

  Then you can invoke Jota by calling jota

  (Please see https://launchpad.net/bugs/145267 for details, why invoking
  a gem is not straight forward on Ubuntu)


Fedora Linux
------------
(Tested with Fedora 14)

Install Ruby + Gems:
  yum install ruby rubygems

Install GTK+ + Ruby bindings:
  yum install ruby-gtk2                 # (recommended)
or
  yum groupinstall "Development Tools" "Legacy Software Development"
  yum install gtk2-devel
  gem install gtk2

Install Jota:
  gem install jota                      # (recommended)
or
  Download a jota-VER.gem from http://rubygems.org/gems/jota. VER stand
  for the version you are looking for.
  gem install jota-VER.gem

Call Jota:
  jota


OpenSUSE Linux
--------------
(Tested with OpenSUSE 11.4)

Install Ruby + Gems:
  zypper install ruby rubygems

Install GTK+ + Ruby bindings:
  zypper install -t pattern devel_C_C++
    (There is no prebuild ruby-gtk package, therefore we need this 
    cumbersome way to install the Ruby bindings for GTK+.)
  gem install gtk2

Install Jota:
  gem install jota                      # (recommended)
or
  Download a jota-VER.gem from http://rubygems.org/gems/jota. VER stand
  for the version you are looking for.
  gem install jota-VER.gem

Call Jota:
  jota


FreeBSD
-------
(Tested with FreeBSD 8.2)

Install Ruby + Gems:
  cd /usr/ports/lang/ruby18; make install # (Select OK)
  cd /usr/ports/devel/ruby-gems; make install

Install GTK+ + Ruby bindings:
  cd /usr/ports/x11-toolkits/ruby-gem2; make install  # (recommended)
or
  gem install gtk2

Install Jota:
  gem install jota                      # (recommended)
or
  Download a jota-VER.gem from http://rubygems.org/gems/jota. VER stand
  for the version you are looking for.
  gem install jota-VER.gem

Call Jota:
  jota


Windows
-------
(Tested with Windows XP)

Install Ruby + Gems:
  Goto http://rubyinstaller.org
  Download the latest 1.8.x version (at least 1.8.7)
  Install 
    Install into default folder (like c:\Ruby187)
    Check box: Add Ruby executable to your PATH
    Check box: Associate .rb and .rbw files with this Ruby installation

Install GTK+ + Ruby bindings:
  Execute (1): gem install gtk2

Install Jota:
  Execute (1): gem install jota         # (recommended)
or
  Download a jota-VER.gem from http://rubygems.org/gems/jota. VER stands
  for the version you are looking for.
  Execute (1): gem install jota-VER.gem

Call Jota:
  Execute(1): jota
or
  Create a shortcut and point it to 
  "C:\Ruby187\bin\rubyw C:\Ruby187\bin\jota" (2)

When you call jota with rubyw instead of ruby, you won't get a command
window hanging around.


(1) Execute either by
    - clicking Start->Run on Windows XP
    - hitting Win-R
    - opening a command prompt window (cmd.exe) and entering a command

(2) Use the install path from the first step instead of c:\Ruby187,
    if different.



UPDATING
========

gem update jota

  or

gem uninstall jota
gem install jota
gem cleanup jota



DEVELOPMENT TOOLS
=================

If you want to contribute to the development of Jota you need the following
tools:

- rake          "make" alternative with ruby syntax
- rdoc          inline documentation generator
- rtags         "tags" for ruby code

Jota/INSTALL (last edited 2015-12-08 08:49:56 by dz)