README.txt

   1 This file is for you to describe the floof application. Typically
   2 you would include information such as the information below:
   3
   4 Installation and Setup
   5 ======================
   6
   7 Install ``floof`` using easy_install::
   8
   9     easy_install floof
  10
  11 Make a config file as follows::
  12
  13     paster make-config floof config.ini
  14
  15 Tweak the config file as appropriate and then setup the application::
  16
  17     paster setup-app config.ini
  18
  19 Then you are ready to go.
  20
  21 Creating models
  22 ======================
  23
  24 To create a new model class, type::
  25
  26     paster model mymodel
  27
  28 Once you have defined your model classes in mymodel, import them in floof/models/__init__.py::
  29
  30     from mymodel import MyEntity
  31
  32 To create tables use create_sql::
  33
  34     paster create_sql
  35
  36 To drop tables use drop_sql::
  37
  38     paster drop_sql
  39
  40 Note that you must first import your classes into floof/models/__init__.py in order for the database commands to work !
  41