From e72546d4b86106be3315ad276da6bbb4d162d999 Mon Sep 17 00:00:00 2001 From: Wookey Date: Wed, 10 Sep 2014 23:46:05 +0100 Subject: [PATCH] Update the README file a bit - still needs work. --- README.txt | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.txt b/README.txt index d488cde..3c8e334 100644 --- a/README.txt +++ b/README.txt @@ -1,15 +1,16 @@ -Troggle is an application for caving expedition data management, originally created for use on Cambridge University Caving Club expeditions and licensed under the GNU Lesser General Public License. +Troggle is an application for caving expedition data management, originally created for use on Cambridge University Caving Club (CUCC)expeditions and licensed under the GNU Lesser General Public License. + +Troggle has been forked into two projects. The original one is maintained by Aron Curtis and is used for Erebus caves. The CUCC variant uses files as the definitive data, not the database and lives at expo.sruvex.com/troggle. Troggle setup ========== Python, Django, and Database setup ----------------------------------- -Troggle requires Django 1.1 or greater, and any version of Python that works with it. As of writing this readme, there was no actual Django 1.1 release, so Troggle required the SVN version of Django. Check Django out to somewhere on your PYTHONPATH with the following command: +Troggle requires Django 1.4 or greater, and any version of Python that works with it. +Install Django with the following command: -apt-get install python-django on debian/ubuntu - -If you have an older installation of Django installed on your system, the easiest way to make sure troggle is using the newest version of Django is to simply checkout into your top troggle directory, into a folder called django. +apt-get install python-django (on debian/ubuntu) If you want to use MySQL or Postgresql, download and install them. However, you can also use Django with Sqlite3, which is included in Python and thus requires no extra installation. @@ -21,6 +22,7 @@ Choose a directory where you will keep troggle, and svn check out Troggle into i svn co http://troggle.googlecode.com/svn/ + If you want to work on the source code and be able to commit, you will need to use https instead of http, and your google account will need to be added to the troggle project members list. Contact aaron dot curtis at cantab dot net to get this set up. Next, you need to fill in your local settings. Copy either localsettingsubuntu.py or localsettingsserver.py to a new file called localsettings.py. Follow the instructions contained in the file to fill out your settings.