# HG changeset patch # User Gustavo Picon # Date 1271616814 18000 # Branch 1.6.X # Node ID b510c7559b915a59f647276affd460e24c85ae9c # Parent ae6d3c6ad2be94942d50b7b39c897a04eea37f3b updating README diff -r ae6d3c6ad2be94942d50b7b39c897a04eea37f3b -r b510c7559b915a59f647276affd460e24c85ae9c README --- a/README Sun Apr 18 13:49:31 2010 -0500 +++ b/README Sun Apr 18 13:53:34 2010 -0500 @@ -2,41 +2,24 @@ django-treebeard ================ -django-treebeard is a library that implements efficient tree -implementations for the Django Web Framework 1.0+. It includes 3 different -tree implementations: Adjacency List, Materialized Path and Nested Sets. -Each one has it's own strength and weaknesses but share the same -API, so it's easy to switch between implementations. +django-treebeard is a library that implements efficient tree implementations +for the Django Web Framework 1.0+, written by Gustavo Picón and licensed under +the Apache License 2.0. -django-treebeard uses Django Model Inheritance with abstract classes -to let you define your own models. To use django-treebeard: +django-treebeard is: - 1. Run `easy_install django-treebeard` to install the - latest treebeard version from PyPi - 1.1. If you don't like easy_install, download a release from the - treebeard download page or get a development version - from the treebeard mercurial repository and run - `python setup.py install` - 2. Add 'treebeard' to the `INSTALLED_APPS` section in your - django settings file. - 3. Create a new model that inherits from one of django-treebeard's - abstract tree models: mp_tree.MP_Node (materialized path), - ns_tree.NS_Node (nested sets) or al_tree.AL_Node - (adjacency list). - 4. Run `python manage.py syncdb` - 5. (Optional) If you are going to use the `admin.TreeAdmin` - class for the django admin, you should install treebeard as a - directory instead of an egg: - `easy_install --always-unzip django-treebeard`. - If you install treebeard as an egg, you'll need to enable - `django.template.loaders.eggs.load_template_source` in the - `TEMPLATE_LOADERS` setting in your django settings file. - Either way, you need to add the path (filesystem or python - namespace) to treebeard's templates in `TEMPLATE_DIRS`. - Also you need to enable `django-core-context-processors-request`_ - in the ``TEMPLATE_CONTEXT_PROCESSORS`` setting in your django - settings file. +- **Flexible**: Includes 3 different tree implementations with the same API: + + 1. Adjacency List + 2. Materialized Path + 3. Nested Sets + +- **Fast**: Optimized non-naive tree operations (see Benchmarks). +- **Easy**: Uses Django Model Inheritance with abstract classes to define your own + models. +- **Clean**: Testable and well tested code base. Code/branch test coverage is above + 96%. You can find the documentation in - http://docs.tabo.pe/django-treebeard/tip/ + https://tabo.pe/projects/django-treebeard/docs/tip/