KeepNote INSTALL Instructions
=============================


Windows Install

  There is a Binary Installer for Windows available on the KeepNote website.
  It is the recommended way to install KeepNote for Windows.


Linux Install

  Debian 
    If you run the Debian distribution, I have created a *.deb package for
    keepnote available from the KeepNote website.  This package will 
    automatically install any dependencies.  Once you download a package
    keepnote_X.Y.Z-1_all.deb you can install it with the command

    $ dpkg -i keepnote_X.Y.Z-1_all.deb
    
    You most likely need root permissions for this command.

  
  Other Linux distributions:

  Required libraries  
    For example, if you use Debian or something compatible...

    $ apt-get install python python-gtk2 python-glade2 libgtk2.0-dev

    You most likely need root permissions for this command.

  Optional libraries

    To use spell checking you will need:

    $ apt-get install python-gnome2-extras

  Once third-party libraries are installed, you can extract the .tar.gz file
  using the command (if you haven't already done so):

    $ tar zxvf keepnote-X.Y.Z.tar.gz

  Where X.Y.Z is the version of KeepNote you have downloaded.  One of
  the easiest ways to run keepnote, is directly from its source
  directory using the command

    $ YOUR_DOWNLOAD_PATH/keepnote-X.Y.Z/bin/keepnote

  or you can install with python distutils

    $ python setup.py install

  To install KeepNote as user you can do 

    $ python setup.py install --prefix=YOUR_INSTALL_LOCATION

  Lastly, KeepNote can be installed using Python's easy_install system

    $ easy_install keepnote

  This will download and install KeepNote to your default path.


MacOS X Install

  All third-party libraries for the Linux version of KeepNote are 
  cross-platform and should also work for MacOS X.  

     - python (http://www.python.org)
     - gtk (http://www.gtk.org)
     - pygtk (http://www.pygtk.org)

  All of these libraries are also available through fink for MaxOS X.  Once
  installed, KeepNote can be run directly from its source directory

    $ path-to-keepnote-src/bin/keepnote

  
  Alternative: Another option for running KeepNote is to use the Windows 
  version in WINE or another Virtual Machine (VMware, etc).


=============================================================================
Windows Build

  Most people will just want to install KeepNote.  For basic installation, 
  see the Windows Install instructions above.  These instructions are for 
  developers who want to *build* the windows installer.
  
  First install these third party packages.  Versions that are known
  to work are given below, but higher version are likely to also work.
  
    python-2.5.1.msi
    gtk-dev-2.12.9-win32-2.exe
    pygtk-2.12.1-1.win32-py2.5.exe
    pyobject-2.14.1-1.win32-py2.5.exe
    pycario-1.4.12-1.win32-py2.5.exe
    py2exe-0.6.6.win32-py2.5.exe
    isetup-5.2.3.exe  (Inno Setup)
  
  NOTE: pygtk-2.12.1-2.win32-py2.5.exe (notice the -2) seems to have a bug
  with get_source_widget()

  Once third-party packages are installed, execute in the KeepNote source dir:
  
    $ python setup.exe py2exe

  - Use Inno to compile installer.iss
  
  Installer will be in Output/keepnote-X.Y.Z.exe