Windows-README
authorJoachim Breitner <mail@joachim-breitner.de>
Fri, 25 Dec 2009 13:52:32 +0000 (13:52 +0000)
committerJoachim Breitner <mail@joachim-breitner.de>
Fri, 25 Dec 2009 13:52:32 +0000 (13:52 +0000)
README.Win32 [new file with mode: 0644]
setup.iss

diff --git a/README.Win32 b/README.Win32
new file mode 100644 (file)
index 0000000..ef2328b
--- /dev/null
@@ -0,0 +1,66 @@
+arbtt, the Automatic Rule-Based Time Tracker
+
+(c) 2009 Joachim Breitner <mail@joachim-breitner.de>
+
+The Automatic Rule-Based Time Tracker is a desktop daemon that runs in the
+background and, every minute, records what windows are open on your
+desktop, what their titles are, which one is active. The accompanied
+statistics program lets you derive information from this log file, i.e.
+what how much of your time have you been spending with e-Mail, or what
+projects are your largest time wasters. The mapping from the raw window
+titles to sensible "tags" is done by a configuration file with an powerful
+syntax.
+
+At this point, arbtt does not have a graphical user interface. You will see no
+indication that arbtt-capture is running besides its entry in the task manager.
+The statistics can be accessed using the arbtt-stats program from the command
+line.
+
+Installation
+============
+
+This installation will put the programs, documentation and example configuration
+on your computer. It makes sure that arbtt-capture is started after the
+installation and after the computer restarts. It also adds the arbtt program
+directory to the system PATH, so that you can use arbtt-stats from the windows
+command line.
+
+The documentation and the file categorize.cfg can be found in the start menu.
+
+You can uninstall arbtt using the provided uninstaller. Please terminate the
+arbtt-capture process before doing so, using the task manager, which you can
+start with Alt-Ctrl-Delete.
+
+Third party components copyright notice
+=======================================
+
+arbtt ships with pcre.dll from the PCRE library, copyright 19976-2006 University
+of Cambridge, governed under this license:
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+    * Neither the name of the University of Cambridge nor the name of Google
+      Inc. nor the names of their contributors may be used to endorse or
+      promote products derived from this software without specific prior
+      written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
index b2f1c68..845f449 100644 (file)
--- a/setup.iss
+++ b/setup.iss
@@ -18,8 +18,7 @@ Compression=lzma
 SolidCompression=yes\r
 ; Is there a point in displaying the LICENSE file?\r
 ; LicenseFile=LICENSE\r
-; TODO: README is UTF-8\r
-InfoBeforeFile=README\r
+InfoBeforeFile=README.Win32\r
 ChangesEnvironment=yes\r
 \r
 [Tasks]\r