 ____  _             _        _                _      _   
/ ___|| |_ __ _  ___| | __   / \   _ __  _ __ | | ___| |_ 
\___ \| __/ _` |/ __| |/ /  / _ \ | '_ \| '_ \| |/ _ \ __|
 ___) | || (_| | (__|   <  / ___ \| |_) | |_) | |  __/ |_ 
|____/ \__\__,_|\___|_|\_\/_/   \_\ .__/| .__/|_|\___|\__|
                                  |_|   |_|               
                                  
              Copyright 2011 - Nathan Osman
==========================================================

StackApplet is an indicator for your Gnome panel that follows
your progress on any StackExchange site.

StackApplet currently can do the following:

- Track your reputation on any site
- Alert you of comments made to you on any followed site
- Add / remove / customize the sites you follow

StackApplet is written in Python and uses the AppIndicator
module.

Contents:

1. Running StackApplet
   1.1 Running on Ubuntu
   1.2 Running on other Linux distros
   1.3 Building / running on Windows
2. Translating StackApplet

===================================
1. Running StackApplet

StackApplet can be run by going to Applications->Accessories->StackApplet or by
running the following command:

    python /usr/share/stackapplet/stackapplet.py

If you are using Ubuntu 11.04 or later, simply press the super key, type
"stackapplet", and push [enter].

====================================
1.1 Running on Ubuntu

StackApplet is designed to take advantage of the new AppIndicator module
included with recent versions of Ubuntu. StackApplet will detect its presence
and automatically use it when it is available.

If you do not have this module installed, see the following section:

====================================
1.2 Running on other Linux distros

Running on other Linux distros is made possible thanks to the replacement for
AppIndicators and PyNotify included with StackApplet. These small modules
expose the same or similar functionality to StackApplet and translates the
functions to their Gtk.StatusIcon / PyNotify equivalent.

====================================
1.3 Building / running on Windows

It is now possible to run StackApplet on Windows. The Python scripts themselves
will run unmodified on Windows. Generating the installation file can be done
using the following instructions:

  1. Download and install Python 2.6, PyGTK, PyInstaller, PyWin32, and InnoSetup.
  2. Run 'python stackapplet.py' to verify that StackApplet launches.
  3. Run 'python Build.py other/windows/stackapplet.spec', where 'Build.py' is
     the Python script from PyInstaller.
  4. Open the InnoSetup script ('/other/windows/setup.iss') and build the
     installer.

Note that it is possible to create the installer using Wine on another
platform. If PyInstaller is installed in 'C:\PyInstaller', then you can simply
run:

    other/windows/build_in_wine.sh

Also note that the replacement modules for AppIndicators and PyNotify are
designed to run in Windows.

====================================
2. Translating StackApplet

Translating StackApplet is very simple. First, you should make sure that the
POT file is up to date by running the following script included with the
source:

    ./generate_translation_file

Then you can create the .mo files as per usual.

Once the .mo files are created, they can be copied to their proper location by
running the following command:

    ./convert_and_move_translations
