Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Tidied up the top-level directory's documentation.

README.txt is now more to the point and mentions standalone testing,
since that's a bit hidden. Also added an AUTHORS.txt file for
consistency.
  • Loading branch information...
commit e377050f1b39ead114a1c14d907cbd4c3bb2143f 1 parent 009f73b
Malcolm Tredinnick authored

Showing 2 changed files with 27 additions and 9 deletions. Show diff stats Hide diff stats

  1. +2 0  AUTHORS.txt
  2. +25 9 README.txt
2  AUTHORS.txt
... ... @@ -0,0 +1,2 @@
  1 +Malcolm Tredinnick <malcolm@pointy-stick.com>
  2 +
34 README.txt
@@ -2,9 +2,17 @@
2 2 Acacia -- Simple Topic Trees
3 3 ============================
4 4
5   -Acacia is a small Django application that provides hierarchical topic or
6   -category naming. Other Django applications can then use the topic trees to
7   -categorise articles or objects with human-readable names.
  5 +Acacia is a small Django application that provides hierarchical topic naming.
  6 +Other Django applications can use the topic trees to categorise and retrieve
  7 +objects using human-readable names.
  8 +
  9 +Documentation
  10 +=============
  11 +
  12 +Full documentation for Acacia is available in the docs/ directory of the
  13 +source. It is marked up using the Sphinx documentation system -- restructured
  14 +text plus some extras for inter-file connections. Running "make html" in the
  15 +docs directory is one way to create the HTML version.
8 16
9 17 Dependencies
10 18 ============
@@ -13,14 +21,22 @@ This code should run on Python 2.4 or later and Django 1.0.3 or later.
13 21
14 22 Acacia uses django-treebeard_ to provide the underlying tree implementation,
15 23 so that will need to be importable before you can use this code
16   -(``django-treebeard`` doesn't require installation, so it only has to be on
17   -the Python import path, not part of Django's ``INSTALLED_APPS`` setting).
  24 +(``django-treebeard`` doesn't appear to require installation, so it only has
  25 +to be on the Python import path, not part of Django's ``INSTALLED_APPS``
  26 +setting).
18 27
19 28 .. _django-treebeard: http://code.google.com/p/django-treebeard/
20 29
21   -More Documentation
22   -==================
  30 +Testing
  31 +=======
23 32
24   -Full documentation for Acacia is available in the docs/ directory of the
25   -source.
  33 +Acacia uses the standard Django testing framework. Any execution of
  34 +"django-admin.py test" (or "manage.py test") in a project that has Acacia
  35 +installed will execute the Acacia tests.
  36 +
  37 +In addition to this, there is a testing/runtests.py script for executing the
  38 +tests in standalone mode. This makes testing during development of Acacia
  39 +itself easier, as it removes the need to install Acacia into a fake Django
  40 +project. Execute that script from anywhere and it will run through all of
  41 +Acacia's unittests in isolation.
26 42

0 comments on commit e377050

Please sign in to comment.
Something went wrong with that request. Please try again.