Update README

This commit is contained in:
Ross Poulton 2011-02-05 04:51:34 +00:00
parent 9d4a715804
commit ad93e7c884

View File

@ -1,6 +1,7 @@
django-helpdesk - A Django powered ticket tracker for small enterprise. django-helpdesk - A Django powered ticket tracker for small enterprise.
=======================================================================
(c) Copyright 2009 Jutda. All Rights Reserved. See LICENSE for details. (c) Copyright 2009-11 Jutda. All Rights Reserved. See LICENSE for details.
django-helpdesk was formerly known as Jutda Helpdesk, named after the django-helpdesk was formerly known as Jutda Helpdesk, named after the
company who originally created it. As of January 2011 the name has been company who originally created it. As of January 2011 the name has been
@ -18,25 +19,22 @@ Complete documentation is available in the docs/ directory, or online at http://
3. Upgrading from previous versions 3. Upgrading from previous versions
4. Installation 4. Installation
#########################
1. Licensing 1. Licensing
######################### ------------
See the file 'LICENSE' for licensing terms. Note that django-helpdesk is See the file 'LICENSE' for licensing terms. Note that django-helpdesk is
distributed with 3rd party products which have their own licenses. See distributed with 3rd party products which have their own licenses. See
LICENSE.3RDPARTY for license terms for included packages. LICENSE.3RDPARTY for license terms for included packages.
#########################
2. Dependencies (pre-flight checklist) 2. Dependencies (pre-flight checklist)
######################### --------------------------------------
1. Python 2.4+ 1. Python 2.4+
2. Django (1.2 or newer) 2. Django (1.2 or newer)
3. An existing WORKING Django project with database etc. If you 3. An existing WORKING Django project with database etc. If you
cannot log into the Admin, you won't get this product working. cannot log into the Admin, you won't get this product working.
NOTE REGARDING SQLITE AND SEARCHING: **NOTE REGARDING SQLITE AND SEARCHING:**
If you use sqlite as your database, the search function will not work as If you use sqlite as your database, the search function will not work as
effectively as it will with other databases due to its inability to do effectively as it will with other databases due to its inability to do
case-insensitive searches. It's recommended that you use PostgreSQL or MySQL case-insensitive searches. It's recommended that you use PostgreSQL or MySQL
@ -46,20 +44,19 @@ http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching
When you try to do a keyword search using sqlite, a message will be displayed When you try to do a keyword search using sqlite, a message will be displayed
to alert you to this shortcoming. There is no way around it, sorry. to alert you to this shortcoming. There is no way around it, sorry.
#########################
3. Upgrading from previous versions 3. Upgrading from previous versions
######################### -----------------------------------
If you are upgrading from a previous version of django-helpdesk, you should If you are upgrading from a previous version of django-helpdesk, you should
read the UPGRADING file to learn what changes you will need to make to get read the UPGRADING file to learn what changes you will need to make to get
the current version of django-helpdesk working. the current version of django-helpdesk working.
1. Find out your current version of django-helpdesk. In the 'helpdesk' folder, 1. Find out your current version of django-helpdesk. In the 'helpdesk' folder,
use the 'svn' command to find the current revision: use the 'svn' command to find the current revision::
svn info . svn info .
Look for the 'Revision' line, eg: Look for the 'Revision' line, eg::
Revision: 92 Revision: 92
@ -71,9 +68,8 @@ the current version of django-helpdesk working.
4. Continue to the 'Initial Configuration' area, if needed. 4. Continue to the 'Initial Configuration' area, if needed.
#########################
4. Installation 4. Installation
######################### ---------------
``pip install django-helpdesk`` ``pip install django-helpdesk``