Commits

Lars Yencken  committed 6b18e82

Provides overview of project

  • Participants
  • Parent commits 46e8fba

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/lars512/django-hierarchy/wiki/
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+== Overview ==
+
+This project provides a simple and convenient way to store hierarchical data (i.e. a tree) in Django. By inheriting from the {{{HierarchicalModel}}} class provided, you automatically get the extra fields you need, and the special methods required to insert data into this special form of table. This project provides the nested set abstraction for hierarchical models, which (roughly speaking) is slow to write to but very fast to read from.
+
+For comparison, see the [[http://code.google.com/p/django-mptt/|django-mptt]] project which provides similar functionality, and is probably better documented.