====== RedNotebook ======

There are many packages available for different distributions, so you might
want to check the Downloads page first.

It is recommended to install the distribution's appropriate package, 
but of course sometimes you want to try out the bleeding edge, hot new stuff.

In order to not mess with your distribution's package system, you might
want to just run the program, without installing it.


=====  RUN RedNotebook on Ubuntu/Debian/Mint  =====
In this directory:
  - sudo apt-get install python-yaml python-webkit
  - python rednotebook/redNotebook.py
  
=====  RUN RedNotebook on Fedora  =====
In this directory:
  - yum install python-devel PyYAML pywebkitgtk
  - python rednotebook/redNotebook.py


======  Short Install Instructions  ======

====  INSTALL RedNotebook on Ubuntu/Debian/Mint  ====
In this directory:
  - sudo apt-get install python-yaml python-webkit
  - sudo python setup.py install
  
==== INSTALL RedNotebook on Fedora ====
In this directory:
  - yum install python-devel PyYAML pywebkitgtk
  - sudo python setup.py install
  

You find a menu entry for RedNotebook under "Office".
  


====== Detailed Instructions ======

===== REQUIREMENTS =====
  - Python (2.5/2.6) (www.python.org)
  - PyYaml (>=3.05) (www.pyyaml.org)
  - PyGTK (>=2.13) (www.pygtk.org)
  
  - OPTIONALLY:
    - pywebkitgtk (>=1.1.5) (http://code.google.com/p/pywebkitgtk/)
      Used for a nicer preview and PDF export
    - python-chardet (http://chardet.feedparser.org)
      Better recognition of file encodings
  
    === Ubuntu/Debian ===
    sudo apt-get install python-yaml python-webkit
    
    === Fedora ===
    yum -y install python-devel PyYAML pywebkitgtk
    

===== INSTALL =====
Run 'sudo python setup.py install'
(installs into path-to-python/site-packages/)


===== RUN =====
After installing you can run the command "rednotebook" in any shell. 
You should also find a menu entry for RedNotebook under "Office".

(Running without installing: Just navigate to the "rednotebook" directory 
                             and run "./rednotebook".)


===== THANKS =====

  - The authors of the programs listed under 'requirements'. Remember that
			without them, RedNotebook would not be possible
  - Everaldo Coelho (www.everaldo.com) for the excellent icon
  - The txt2tags team (http://txt2tags.sf.net) for their super cool markup tool
  - Gustavo J. A. M. Carneiro for his htmltextview.py module used by the clouds
  - The people behind the Tango Icon Project and the creators of the Human Theme
			Their work can be downloaded from http://tango.freedesktop.org/
  - Matt Rasmussen and his KeepNote project (http://rasm.ods.org/keepnote/). 
  			RedNotebook uses his work on displaying HTML content 
			in a PyGTK application for the preview.
  - Ahmet Öztürk and Lifeograph for his markup highlighting idea
  - Hannes Matuschek: RedNotebook uses pygtkcodebuffer for the markup
			highlighting 


Enjoy!
