README

   1 == Documentation ==
   2
   3 Please visit our wiki is at: http://wiki.mwamko.org
   4
   5
   6 == Installing ==
   7
   8 Instructions are in the INSTALL file.
   9
  10
  11 == Launching ===
  12
  13 Run: ./script/mwamko start
  14
  15
  16 == Console ==
  17
  18 You can interact with the domain model by starting the console through
  19 script/console. Here you'll have all parts of the application configured,
  20 just like it is when the application is running. You can inspect domain
  21 models, change values, and save to the database. Starting the script without
  22 arguments will launch it in the development environment.
  23
  24 Passing an argument will specify a different environment,
  25 like: script/console production
  26
  27 To reload your controllers and models after launching the console
  28 run: reload!
  29
  30
  31 == Description of contents ==
  32
  33 app
  34   Holds all the code that's specific to this particular application.
  35
  36 app/controllers
  37   Holds controllers that should be named like weblog_controller.rb for
  38   automated URL mapping. All controllers should descend from
  39   ActionController::Base.
  40
  41 app/models
  42   Holds models that should be named like post.rb.
  43   Most models will descend from ActiveRecord::Base.
  44
  45 app/views
  46   Holds the template files for the view that should be named like
  47   weblog/index.rhtml for the WeblogController#index action. All views use eRuby
  48   syntax. This directory can also be used to keep stylesheets, images,
  49   and so on that can be symlinked to public.
  50
  51 app/helpers
  52   Holds view helpers that should be named like weblog_helper.rb.
  53
  54 config
  55   Configuration files for the Rails environment, the routing map,
  56   the database, and other dependencies.
  57
  58 db
  59   Contains the database schema in schema.rb.  db/migrate contains all
  60   the sequence of Migrations for your schema.
  61
  62 lib
  63   Application specific libraries. Basically, any kind of custom code
  64   that doesn't belong under controllers, models, or helpers. This
  65   directory is in the load path.
  66
  67 public
  68   The directory available for the web server. Contains subdirectories
  69   for images, stylesheets, and javascripts. Also contains the dispatchers
  70   and the default HTML files.
  71
  72 script
  73   Helper scripts for automation and generation.
  74
  75 test
  76   Unit and functional tests along with fixtures.
  77
  78 vendor
  79   External libraries that the application depends on. Also includes the
  80   plugins subdirectory. This directory is in the load path.