ramaze 0.0.7 → 0.0.8

data/doc/INSTALL

@@ -0,0 +1,34 @@
+= Installating Ramaze
+
+* via RubyGems
+
+  The simplest way of installing Ramaze is via 
+
+    $ gem install ramaze
+
+  in case you have RubyGems installed.
+  (this will work as soon as I have registered on RubyForge ;)
+
+* via install.rb
+
+  Ramaze provides a basic install.rb that should take care of the installation
+  you can use it like 
+
+    $ ruby install.rb
+
+  you may need root-privileges to do
+  that, depending on what options you provide.
+  (please note that I haven't tested the install.rb extensively yet, so if you
+  find some quirks, please send me patches or a simple note)
+
+* via darcs
+
+  To get the latest and sweetest, you can just pull from the repository and run
+  Ramaze that way.
+
+    $ darcs get http://manveru.mine.nu/ramaze
+
+  Please read the man page or `darcs help` for more information about updating
+  and creating your own patches.
+  This is at the moment the premier way to use Ramaze, since it is the way I use
+  it.

data/doc/ProjectInfo

@@ -0,0 +1,53 @@
+---
+project : ramaze
+version : '0.0.7'
+status  : alpha
+
+title    : Ramaze
+subtitle : A light and modular Web-Framework
+description : >
+  Ramaze is a very simple and straight-forward web-framework.
+  The philosophy of it could be expressed in a mix of KISS and POLS, trying to
+  make simple things simple and complex things possible.
+
+author     : Michael Fellinger <m.fellinger@gmail.com>
+created    : "2006-10-14"
+homepage   : "http://ramaze.rubyforge.org"
+download   : "https://rubyforge.org/frs/?group_id=3034"
+repository : "http://manveru.mine.nu/darcs/ramaze"
+slogan     : Ramaze, light and modular
+#signiture  : "../_privkey.pem"
+
+pack       : [gem, tgz, bz2]
+distribute : [ -scrap ]
+dependency :
+  - [ autorake, >= 0.5.1 ]
+executable : [ bin/ramaze ]
+
+#digest     : sha256
+#manifest   : MANIFEST.txt
+archive    : ~/ruby/ARCHIVE
+scm        : darcs
+scm_ignore : [ doc/allison ]
+changelog  : doc/CHANGELOG
+stamp      : doc/VERSION
+
+rdoc:
+  template : allison
+
+mail:
+  server   : smtp.gmail.com
+  account  : m.fellinger@gmail.com
+  mail_to  : m.fellinger@gmail.com
+
+rubyforge:
+  project  : ramaze
+  username : manveru
+  groupid  : 3034
+  package  : ramaze
+
+#host:
+#  domain   : rubyforge.org
+#  user     : transami
+#  root     : '/var/www/gforge-projects/ratchets'
+

data/doc/README

@@ -1,7 +1,7 @@
-           Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
-  All files in this distribution are subject to the terms of the Ruby license.
+          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+ All files in this distribution are subject to the terms of the Ruby license.
 
-= Readme for Ramaze
+= About Ramaze
 
 Ramaze is a very simple and straight-forward web-framework.
 The philosophy of it could be expressed in a mix of KISS and POLS, trying to
@@ -12,89 +12,44 @@ forgotten in a chase for new functionality and features. Ramaze only tries to
 give you the ultimate tools, but you have to use them yourself to achieve
 perfect custom-tailored results.
 
-Another interesting aspect is that Ramaze tries to provide as much reusable
-code as possible, as to encourage the use of its code in similar projects and
-to act as a single point of reference for projects using its components.
-This tries to tackle the problem that everybody who wants/needs to create a
-custom web framework always has to reimplement the most basic and common
-functionality.
+Another one of the goals during development of Ramaze was to make every part as
+modular and therefor reuasable as possible, not only to provide a basic
+understanding after the first glance, but also to make it as simple as possible
+to reuse parts of the code.
 
-So when for example someone wants a basic example of how to build a comfortable
-testing environment for a web framework it's hardly leading to the goal if this
-first has to be reinvented before even the basic testing can start.
+The original purpose of Ramaze was to act as a kind of framework to build
+web-frameworks, this was made obsolete by the introduction of rack, which
+provides this feature at a better level without trying to enforce any structural
+layout of the resulting framework.
 
-The same goes for the implementation of sessions or the request/response
-objects which are collected under the module Trinity. Or all the examples
-of real world-usage of the most popular templating-engines. Within a framework,
-not to mention the basic need for a Dispatcher.
 
-Of course most other frameworks will introduce their own paradigms and special
-implementations, and this is the reason why it is not encouraged to directly
-require files from Ramaze, they are one working entity together, but with a few
-modifications it's your very own implementation and fits into your own project.
-Not to mention that introducing another web framework for your own would be
-quite odd ;)
+= Features Overview
 
+Ramaze offers following features at the moment:
 
-== Basic Principles of Ramaze
-
-There are some basic principles that Ramaze tries to follow:
-
-* Test everything
-
-  What use is a wonderful application if it doesn't work?
-
-
-* Document everything
-
-  Documentation is the glue between the code and the programmers brain
-
-
-* Keep It Super Simple (KISS)
-
-  Most things should be understandable after reading them once
-
-
-* Principle Of Least Surprise (POLS)
-
-  Going the way of ruby
-
-
-* Modular design
-
-  Making it as simple as possible to extract parts
-
-
-* Minimal dependencies
-
-  In case a dependency is not met use a simple fall-back instead
+* Adapters
 
+   Ramaze takes advantage of the rack library to provide a common way of
+   handling different ways to serve its content.
 
-* Provide as many examples as possible
+   Rack supports at the moment:
 
-  Examples are a superior way of getting a quick start into everything
+    * Mongrel
 
+      http://mongrel.rubyforge.org/
+      Mongrel is a fast HTTP library and server for Ruby that is intended for
+      hosting Ruby web applications of any kind using plain HTTP rather than
+      FastCGI or SCGI.
 
-* Open development
+    * WEBrick
 
-  I happily accept all patches or feature-requests that you may have,
-  as long as they comply with these principles
+      http://www.webrick.org/
+      WEBrick is a Ruby library program to build HTTP servers.
 
+    * CGI
 
-== Quick features overview
-
-Ramaze offers following features at the moment:
-
-* Adapters
-  * Mongrel
-    http://mongrel.rubyforge.org/
-    Mongrel is a fast HTTP library and server for Ruby that is intended for
-    hosting Ruby web applications of any kind using plain HTTP rather than
-    FastCGI or SCGI.
-
-  * WEBrick
-    http://www.webrick.org/
-    WEBrick is a Ruby library program to build HTTP servers.
+      CGI is the Common Gateway Interface and is one of the most basic ways
+      to integrate into Webservers like Apache, Lighttpd or Nginx.
 
 
 * Templates
@@ -125,7 +80,7 @@ Ramaze offers following features at the moment:
     http://code.whytheluckystiff.net/markaby/
     Markaby means Markup as Ruby.
 
-  * Ramaze
+  * Ezamar
 
     A simple homage to Nitros templating. Please check out http://nitroproject.org
     for more information.
@@ -140,8 +95,10 @@ Ramaze offers following features at the moment:
   * Auth
   * Cache
   * Feed
+  * Flash
   * Form
   * Link
+  * OpenID
   * Redirect
   * Stack
 
@@ -152,28 +109,52 @@ Ramaze offers following features at the moment:
   * Custom Error-handling
 
 
-== Getting started
+= Basic Principles
 
-Now that you have a vague idea of what you're about to get into you might just
-want to get a way to get up and running ASAP.
-Please read below for more information about installation.
+There are some basic principles that Ramaze tries to follow:
 
-Depending on what you are planning to do you can either just go and start
-reading the source or directly get some hands-on experience by trying some of
-the examples.
-Most things will require dependencies though. The basic functionality is
-provided by the WEBrick adapter and the Template::Ramaze, which just run out
-of the box. For more features you will have to install some templating-engines
-and mongrel (_very_ recommended). Ramaze will inform you when it needs further
-dependencies, so just go and try some things.
+* Test everything
+
+  What use is a wonderful application if it doesn't work?
+
+
+* Document everything
+
+  Documentation is the glue between the code and the programmers brain
 
-Some places to get started are:
-- Read the documentation.
-- Run and read the test cases.
-- Look at the examples and run/modify them.
 
+* Keep It Super Simple (KISS)
+
+  Most things should be understandable after reading them once
 
-== Installation
+
+* Principle Of Least Surprise (POLS)
+
+  Going the way of ruby
+
+
+* Modular design
+
+  Making it as simple as possible to extract parts
+
+
+* Minimal dependencies
+
+  In case a dependency is not met use a simple fall-back instead
+
+
+* Provide as many examples as possible
+
+  Examples are a superior way of getting a quick start into everything
+
+
+* Open development
+
+  I happily accept all patches or feature-requests that you may have,
+  as long as they comply with these principles
+
+
+= Installation
 
 * via RubyGems
 
@@ -184,32 +165,63 @@ Some places to get started are:
   in case you have RubyGems installed.
   (this will work as soon as I have registered on RubyForge ;)
 
-* via install.rb
-
-  Ramaze provides a basic install.rb that should take care of the installation
-  you can use it like 
-
-    $ ruby install.rb
-
-  you may need root-privileges to do
-  that, depending on what options you provide.
-  (please note that I haven't tested the install.rb extensively yet, so if you
-  find some quirks, please send me patches or a simple note)
-
 * via darcs
 
   To get the latest and sweetest, you can just pull from the repository and run
   Ramaze that way.
 
-    $ darcs get http://manveru.mine.nu/darcs/prog/projects/ramaze
+    $ darcs get http://manveru.mine.nu/ramaze
 
   Please read the man page or `darcs help` for more information about updating
   and creating your own patches.
   This is at the moment the premier way to use Ramaze, since it is the way I use
   it.
 
+  Some hints for the usage of Darcs.
+
+  * use require 'ramaze' from everywhere
+
+    add a file to your site_ruby named 'ramaze.rb'
+    the content should be: "require '/path/to/darcs/repo/ramaze/lib/ramaze'"
+
+  * get the latest version (from inside the ramaze-directory)
+
+    $ darcs pull
+
+  * record a patch
+
+    $ darcs record
+
+  * output your patches into a bundle ready to be mailed (compress it before
+    sending to make sure it arrives in the way you sent it)
+
+    $ darcs send -o ramaze_bundle
+    $ gzip -c ramaze_bundle > ramaze_bundle.gz
+
+
+= Getting Started
+
+Now that you have a vague idea of what you're about to get into you might just
+want to get a way to get up and running ASAP.
+Please read below for more information about installation.
+
+Depending on what you are planning to do you can either just go and start
+reading the source or directly get some hands-on experience by trying some of
+the examples.
+Most things will require dependencies though. The basic functionality is
+provided by the WEBrick adapter and the Template::Ramaze, which just run out
+of the box. For more features you will have to install some templating-engines
+and mongrel (_very_ recommended). Ramaze will inform you when it needs further
+dependencies, so just go and try some things.
+
+Some places to get started are:
+- Read the documentation.
+- Run and read the test cases.
+- Look at the examples and run/modify them.
+
+
 
-== Ramaze Examples
+= A couple of Examples
 
 There are some examples for your instant pleasure inside the examples-directory
 in the Ramaze-distribution.
@@ -250,7 +262,17 @@ Examples include:
   functionality in each template_*.rb file using a different engine.
 
 
-== good to know
+
+= How to find Help
+
+For help you can:
+
+- Visit us in the channel #ramaze on irc.freenode.net
+
+- Join the Mailinglist at http://ramaze.rubyforge.org
+
+
+= Appendix
 
 * Nicer Error-pages
   * Install coderay (it's a gem)
@@ -267,9 +289,64 @@ Examples include:
     Also, using MemCache gives you high-end performance and security.
 
 
-== Getting Help
+= And thanks to...
+
+There is a large number of people who made Ramaze possibe by their ongoing
+efforts in the world of open source and by encouraging and helping me.
+
+This list is by no means a full listing of all these people, but I try to
+get a good coverage despite that.
+
+I would like to thank:
+
+* Yukihiro Matsumoto a.k.a matz
+
+    For giving the world Ruby and bringing fun back into programming.
+
+* Zed Shawn a.k.a. zedas
+
+    For developing Mongrel, Ramaze started out as a simple Hello World based
+    on that awesome server.
+
+* Christian Neukirchen a.k.a chris2
+
+    For building rack, which is just what the numerous web-developers had
+    anticipated and which will, with no doubt, change the world.
+
+* Pistos
+
+    For continious encouragment and building the first real webpage on Ramaze.
+    His bugreports were invaluable.
+
+* Jim Weirich
+
+    For Rake, which lifts off a lot of tasks from the shoulders of every
+    developer who uses it.
+
+* Thomas Sawyer a.k.a Trans
+
+    Dragging me deep into the rabbit-hole and showing me how awesome Ruby
+    truely is through his work on facets, ratchets and tons of other projects.
+
+* George Moschovitis a.k.a gmosx
+
+    For his tremendous efforts in the Nitro/Og framework, which is a source of
+    steady inspiration for Ramaze and brought me to Ruby in the first place.
+
+* Rob Levin a.k.a. lilo
+
+    He founded the most excellent Freenode IRC-network, where the most important
+    channels for rubyists are located (as is #ramaze).
+    May he rest in peace.
+
+* The guys (and gals) in the various channels on Freenode
 
-For help you can just join #ramaze on irc.freenode.net.
+    As the people are way too many to be listed, here the channels that i call
+    my online home.
+    All the people in there deserve special thanks for getting me hooked to Ruby
+    and providing their help in a friendly and patient manner.
 
-Or mail me, at m [dot] fellinger [at] gmail [dot] com - I'm happy to provide
-help on anything related to web-development.
+    * #nitro
+    * #ruby-de
+    * #ruby-lang
+    * #rubyforce