From 8d16312e470c8477ea3c3ab321111d81794e3738 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sat, 23 Aug 2008 23:21:13 -0700 Subject: [PATCH] Updated to cover some of the Desktop/Server distinction. --- INSTALL | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++------- README | 10 ++++++-- 2 files changed, 75 insertions(+), 11 deletions(-) diff --git a/INSTALL b/INSTALL index fb9af9c..5ec0322 100644 --- a/INSTALL +++ b/INSTALL @@ -1,15 +1,73 @@ -To use Luminotes, please see the included README file instead of this INSTALL -file. This file contains details about installing the Luminotes server, which -you shouldn't need if you only want to make a wiki. +If you just want to create a wiki online, please see the included README +file instead of this INSTALL file. This file contains details about +installing Luminotes Desktop and Luminotes Server, which you shouldn't +need if you only want to make a wiki. + + +Luminotes Desktop +================= + +Luminotes Desktop allows an individual to take notes on their own +computer without an internet connection. First, install the prerequisites: - * Python 2.4 + * Python 2.4 to 2.5 + * CherryPy 2.2 + * pysqlite 2.3 to 2.4 + * simplejson 1.3 + * pytz 2006p to 2008c + * Python Imaging Library 1.1 + * Python Universal Encoding Detector 1.0 + +In Debian GNU/Linux, you can issue the following command to install these +packages: + + apt-get install python2.4 python-cherrypy python-pysqlite2 \ + python-simplejson python-tz python-imaging python-chardet + + +database setup +-------------- + +Initialize the database with the starting schema and default data: + + export PYTHONPATH=. + python2.4 tools/initdb.py -l + + +running Luminotes Desktop +------------------------- + +To start Luminotes, run: + + python2.4 luminotes.py -l + +This will run the local Luminotes web server and automatically launch a web +browser at the following URL: + + http://localhost:8081/ + + +If you're only interested in Luminotes Desktop, you can stop reading here. The +rest of this document describes Luminotes Server. + + + +Luminotes Server +================ + +Luminotes Server allows a team to set up their own Luminotes web server, just +like at luminotes.com. + +First, install the prerequisites: + + * Python 2.4 to 2.5 * CherryPy 2.2 * PostgreSQL 8.1 * psycopg 2.0 * simplejson 1.3 - * pytz 2006p + * pytz 2006p to 2008c * Python Imaging Library 1.1 * Python Universal Encoding Detector 1.0 @@ -205,13 +263,13 @@ will use the module automatically. When Luminotes starts up, you should see a Python unit tests ----------------- -If you're interested in running unit tests of the server, install: +If you're interested in running unit tests, install: * nose 0.9.0 - * pysqlite 2.3 + * pysqlite 2.3 to 2.4 -In Debian GNU/Linux, you can issue the following command to install this -package: +In Debian GNU/Linux, you can issue the following command to install these +packages: apt-get install python-nose python-pysqlite2 diff --git a/README b/README index fa26a8c..fc82386 100644 --- a/README +++ b/README @@ -3,8 +3,14 @@ ideas. For more information, see: http://luminotes.com/ -There is a Luminotes user guide available, which explains how to use Luminotes -and even includes some tips on creating your wiki. You can check it out at: +To start Luminotes Desktop on Windows XP, just click the Start button, click +on "All Programs", and then click on "Luminotes". + +To start Lumintoes Desktop or Server on Linux or Mac OS X, please see the +INSTALL file. + +The Luminotes User Guide explains how to use Luminotes and even includes some +tips on creating your wiki. You can check it out at: http://luminotes.com/guide