= Bivouac

Copyright (C) 2007 Gregoire Lejeune

* http://bivouac.rubyforge.org/
* http://rubyforge.org/projects/bivouac/
* http://greg.rubyfr.net
  
== DESCRIPTION: 

Bivouac is a simple generator for camping[http://code.whytheluckystiff.net/camping].

== FEATURES/PROBLEMS:

=== 0.0.4:
* the application file is now in app and not in app/controller
* Mongrel postamble is no more in the TODO list
* You can specify which address (<tt>-a</tt>) and port (<tt>-P</tt>) to bind to.

=== 0.0.3:
* Model generation is now ok (i hope)
* It's now possible to create "Get Out of Hand" and "Eruby/Erb" projects
* script/generate have 3 new options :
  * <tt>-v</tt> if you don't want to create the view
  * <tt>-d</tt> if you don't want the default route
  * <tt>-r</tt> if you want to add more routes
* Only sqlite3 is supported

=== 0.0.2: 
* So many problems!

=== 0.0.1: 
* Can't generate models and migrates

=== Extra:
* With camping 1.5 there is a bug in /usr/lib/ruby/gems/1.8/gems/camping-1.5/lib/camping/webrick.rb line 59, change <tt>do_GET(req, res)</tt> to <tt>do_GET(req, resp)</tt>

== TODO:

* add test with mosquito[http://code.whytheluckystiff.net/camping/wiki/MosquitoForBugFreeCamping]
* test with Apache and Lighttpd
* add scaffold generator -- who want it ?
* rewrite script/server and remove postamble
* add mysql, postgresql, oracle, ... support 

== SYNOPSIS:

  % bivouac -h
  Usage: bivouac [options] app
  bivouac, the generator for the microframework ON-button 
  for ruby 1.8.6 (2007-06-07) [universal-darwin9.0]

  Specific options:
    -P, --port PORT                  Which port to bind to (3301)
    -a, --address ADDR               Address to bind to (0.0.0.0)
    -o, --organize TYPE              Type or organisation 
                                     (options: JOF:Just On File
                                               GOH:Get Out of Hand
                                               ERB:use Eruby or Erb)
    -p, --postamble TYPE             Add a postamble 
                                     (options: CGI/FastCGI/Mongrel/WEBrick/none)

  Common options:
    -?, --help                       Show this message
    -v, --version                    Show version

  % bivouac your_app_name
  ...
  % cd your_app_name
  % ruby script/generate -h
  Usage: script/generate generator [options] [args]

  Generators
    Builtin: controller, model, migrate, view

  controller generator options:
    -v, --no-view                    Do not generate any view for the controller
    -d, --no-route                   Do not add the default route to the controller 
                                     (/controller_name)
    -r, --route ROUTE,ROUTE,...      Add ROUTES to the controller

  Common options:
    -h, --help                       Show this message
  
  % ruby script/generate controller your_controller
  ...
  % ruby script/server
  ...

== REQUIREMENTS:

* camping
* mime-types
* extra

== INSTALL:

  sudo gem install bivouac
  
== LICENSE:

Bivouac is freely distributable according to the terms of the
GNU General Public License.

This program is distributed without any warranty. See the file
'COPYING' for details.