                             Sticky Notes v1.1.4-2
                              ===================
                              by Jrn Christensen

Table of content:
=================
 1. What is Sticky Notes?
 2. Beware!!!
 3. How do I compile/install?
 4. Are there any rpm or deb?
 5. I found a bug...
 6. Feature request!
 7. License information.
 8. Changelog.
 9. Contact information.

Please at least read the bug list - section 5.


1. What is Sticky Notes?
========================

I kind of like the idea of sticking little notes to my desktop - just like
you would stick yellow stickers on your fridge. For a long time, I used
knotes for that purpose but got really really tired of the KDE connection.
(No - I dont think KDE is neat - its rather heavy and has too many
superflously features. I like small programs who only does one job; but
does it well :-)  )

So in lack of alternatives, I decided to write my own version of knotes: 
Snotes (for Sticky Notes). If you compare knotes and snotes (and disregard
the KDE-connection) you will see that
 - The basic idea, as well as the basic layout, is the same.
 - Knotes has a more polished view than Snotes.
 - Overall Snotes is more configurable than Knotes.

As said before, I basically wrote Snotes for my own use, so there are some
bugs and missing features (see bug section) which I do not plan to invest
much time in. I can perfectly use Snotes as it is now. 

So there will probably not be many updates (except for bugfixes) in the future
unless there are requests!



2. BEWARE!!!
============

The data in Snotes are not encrypted. It is stored in plain text in ~/.snotes
and information stored with Snotes should therefor NOT be security
sensitive information - e.g. passwords.

I specifically made Snotes, so when I opened an SSH connection to my computer
I would still be able to read my notes.



3. How do I compile/install?
============================

Requirements:
-------------
 * QT development files
 * libc6 dev files

Compilation:
------------
I used qmake to generate Makefile (and friends). So you have to have qmake
installed also (which is AFAIK a part of the QT dev package you just 
downloaded). It should compile by typing:

   qmake -project
   qmake -nocache
   make


Installation:
-------------
Just copy the binary file snotes to your bin dir.

qmake does not provide any install (or uninstall) script, but since its 
only that one binary (and I originally only intended to use it myself) 
I did not wanna bother with an install script.


Ooops, something went wrong:
----------------------------
Go on... bug hunting time :-)

Since Snotes compiles fine on my system, it is probaby something wrong with
your QT installation (qmake not being able to find the right libs?).


4. Are there any rpm or deb?
----------------------------

Nope!

You wanna make a package? Be my guest :-) Drop me an email; I would be glad
to hear it :-)



5. I found a bug...
-------------------

Good for you :-)

Now... You have several choices, which I here list in prefered order:
 1. You can fix the bug and send me a patch.
 2. You can find out what is causing the bug and mail me how to correct it.
 3. Send me a mail, describing the bug and how to invoke it.
 4. Ignore the bug and keep living your life.
 5. Diss Snotes and find another application. (Deprecated)
 6. Send me a flame mail with REALLY BIG LETTERS and NO usefull
    information - just calling me names, which my mother (and yours too) 
    would be ashamed to hear. (Really deprecated!)


There are some known bugs:
 * The icon does not dock in the task bar of KDE or IceWM.
 - No - This is essentially a feature request. It cannot be a bug since I did
   not implement it. I use WindowMaker which do not have the posibility of
   tray icons. (Instead it uses docking icons - which I have disabled).
   If someone requests the feature (and maybe gives me a hint on how
   to implement it) I might look into it....

 * The sticky feature does not work with {put your favorite WM here}.
 - I implemented the sticky feature as described by netwm standards - (if I
   understood them correctly). It works with WindowMaker (which I uses) so I
   guess its a bug in {again, put your favorite WM here}.



6. Feature request!
===================

Nice. Again, you have several options:
 1. Implement feature and send me a patch.
 2. Send me a mail with feature request.
 3. Mumble and ignore the missing feature.
 4. Mumble, grumble, diss Snotes and find another app. (Deprecated).



7. License information.
=======================

Snotes uses the free version of QT, which is licensed under GPL. Therefore
Snotes is also licensed under GPL. Easy, right?

BTW, this software is provided "as is" with no warranty - so you have been
warned.



8. Changelog:
=============
Please see ChangeLog file.


9. Contact information.
=======================
My email address on sourceforge:
   mettle@users.sourceforge.net


Jrn Christensen
Denmark
