thingfish /

Filename Size Date modified Message
bin
docs
etc
experiments
lib
misc
plugins
spec
var
822 B
141.4 KB
1.5 KB
766 B
1.4 KB
9.8 KB
4.1 KB
4.4 KB
519 B
383 B
1.2 KB
run
260 B
1.9 KB
22.0 KB
= ThingFish

== Authors

* Michael Granger <mgranger@laika.com>
* Mahlon E. Smith <mahlon@laika.com>

== Installation

=== Requirements

ThingFish is written in ruby, and is tested using version 1.8.6:

  * Ruby (>= 1.8.6): http://www.ruby-lang.org/en/downloads/

Other versions may work, but are not tested.

=== Ruby Modules

There are two ways you can install ThingFish. The easiest is to use RubyGems:

  $ sudo gem install -y thingfish

If you'd rather install from source, you'll need these:

  * PluginFactory (>= 1.0.3): http://deveiate.org/projects/PluginFactory
  * UUIDTools (>= 1.0.0): http://rubyforge.org/projects/uuidtools/

Once these are installed:

  $ tar -zxvf thingfish-0.X.N.tgz
  $ cd thingfish-0.X.N
  $ su -
  # rake install

If you want to help out with development, run tests, or generate documentation, 
you'll need a few more things:

  * RSpec (>= 1.1.11): http://rspec.rubyforge.org/
  * rcov (>= 0.8.1): http://eigenclass.org/hiki.rb?rcov
  * lockfile (>= 1.4.3): http://codeforpeople.com/lib/ruby/lockfile/
  * rcodetools (>= 0.7.0): http://eigenclass.org/hiki/rcodetools
  * Redcloth (>= 3.0.4): http://whytheluckystiff.net/ruby/redcloth/
  * ultraviolet (>= 0.10.2) http://ultraviolet.rubyforge.org/

If you have RubyGems installed, you can install these automatically via the 
+install_dependencies+ task of the Rakefile:

  $ sudo rake install_dependencies

For further information on getting your server up and running, see the QUICKSTART file.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.