ratings work. Searching for ratings, not so much yet.

[zzz-floof.git] / README.txt

diff --git a/README.txt b/README.txt
index a1f2914..68db46c 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -17,3 +17,25 @@ Tweak the config file as appropriate and then setup the application::
     paster setup-app config.ini
 
 Then you are ready to go.
     paster setup-app config.ini
 
 Then you are ready to go.

+
+Creating models
+======================
+
+To create a new model class, type::
+
+    paster model mymodel
+
+Once you have defined your model classes in mymodel, import them in floof/models/__init__.py::
+
+    from mymodel import MyEntity
+
+To create tables use create_sql::
+
+    paster create_sql
+
+To drop tables use drop_sql::
+
+    paster drop_sql
+
+Note that you must first import your classes into floof/models/__init__.py in order for the database commands to work !
+