README.rdoc in brite-0.6.0 vs README.rdoc in brite-0.7.0

- old
+ new

@@ -1,61 +1,69 @@ = Brite A Shiny Static Website Generator -* home: http://proutils.github.com/brite -* code: http://github.com/proutils/brite +{Homepage}[http://rubyworks.github.com/brite] / +{Documentation}[http://rubydoc.info/gems/brite/frames] / +{Report Issue}[http://github.com/rubyworks/brite/issues] / +{Development}[http://github.com/rubyworks/brite] / +{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist] +{<img src="http://travis-ci.org/rubyworks/brite.png" />}[http://travis-ci.org/rubyworks/brite] + == DESCRIPTION Brite is an inovative static website/blog generation utility -which is as easy to use as it is versitle. +which is as easy to use as it is versatile. == FEATURES -* Generates files in place (no special subdirectories required). -* Utilizes multi-format templates via Neapolitan. -* Supports many markup and templating formats. +* Site layout is 100% user-defined. +* Can generate files in place, so no "special directories" are required. +* Alternatively templated routes can customize the site organization. +* Supports multi-format templates via Neapolitan template engine. +* Supports many markup and templating formats via Malt or Tilt. == SYNOPSIS -To use Brite create .page, .post and .layout files and then -run: +Very briefly, one creates `.page`, `.post`, .part and `.layout` files and +then runs: $ brite -For details please see the Brite website and the GitHub repository. In -particular have a look at the `site/` directory which contains Brites -own website built on Brite. +Voila, website made! +Of course, the question really is how does one go about creating `.page`, +`.post`, `.part` and `.layout` files and such. For information about that see the +{Brite website}[https://rubyworks.github.com/brite] and see the +{Getting Started Tutorial}[https://github.com/rubyworks/brite/wiki/Getting-Started]. +For a quick start, have a look at the {brite-site repository}[https://github.com/rubyworks/brite-site] +which contains a generic Brite project anyone can use to start their own Brite Site. + +To get further under the hood see Brite source code in the +{GitHub hosted repository}[http://github.com/rubyworks/brite] +and read the {API documentation}[http://rubydoc.info/gems/brite/frames]. + + == HOW TO INSTALL === RubyGems - $ sudo gem install brite + $ gem install brite === Setup.rb -If you're old fashion and want to install to a site -location, see Setup.rb[http://rubyworks.github.com/setup]. +If you're old fashion and want to install to a site location, +see Setup.rb[http://rubyworks.github.com/setup]. -== COPYRIGHT/LICENSE +== COPYRIGHTS -Copyright (c) 2009 Thomas Sawyer +Copyright (c) 2009 Rubyworks -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at +Brite is distributable in accordance to the *BSD-2-Clause* license. - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - +See COPYING.rdoc file for details.