Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 57 lines (33 sloc) 2.018 kB
6c94556 @burke More docs
authored
1 # Zeus
2
3 Zeus preloads your Rails app so that your normal development tasks such as `console`, `server`, `generate`, and specs/tests take **less than one second**.
4
5 This screencast gives a quick overview of how to use zeus with Rails.
6
7 [![Watch the screencast!](http://s3.amazonaws.com/burkelibbey/vimeo-zeus.png)](http://vimeo.com/burkelibbey/zeus)
8
9 More technically speaking, Zeus is a language-agnostic application checkpointer for non-multithreaded applications. Currently only ruby is targeted, but explicit support for other languages is on the horizon.
10
aa15e2f @burke Docs link fixes
authored
11 ## Requirements (for use with Rails)
6c94556 @burke More docs
authored
12
9a0700f @burke Well, linux is nearly-completely working...
authored
13 * OS X 10.7+ *OR* Linux 2.6.13+
6c94556 @burke More docs
authored
14 * Rails 3.0+ (Support for other versions is not difficult and is planned.)
e96879f @burke Rubinius compatibility
authored
15 * Ruby 1.9.3+ with backported GC from Ruby 2.0 *OR* Rubinius
6c94556 @burke More docs
authored
16
e96879f @burke Rubinius compatibility
authored
17 You can install the GC-patched ruby from [this gist](https://gist.github.com/1688857) or from RVM. This is not actually 100% necessary, especially if you have a lot of memory. Feel free to give it a shot first without, but if you're suddenly out of RAM, switching to the GC-patched ruby will fix it.
6c94556 @burke More docs
authored
18
19 ## Installation
20
21 Install the gem.
22
3fd491b @burke README
authored
23 gem install zeus
c1b43bb @burke Slight improvements to ruby docs
authored
24 zeus init
6c94556 @burke More docs
authored
25
26 Q: "I should put it in my `Gemfile`, right?"
27
28 A: You can, but running `bundle exec zeus` instead of `zeus` can add precious seconds to a command that otherwise would be quite a bit faster. Zeus was built to be run from outside of bundler.
29
30 ## Usage
31
32 Start the server:
33
34 zeus start
35
922556f @burke README
authored
36 See a list of the available commands:
37
38 zeus commands
39
6c94556 @burke More docs
authored
40 Run some commands:
41
42 zeus console
43 zeus server
44 zeus testrb test/unit/widget_test.rb
45 zeus rspec spec/widget_spec.rb
46 zeus generate model omg
47 zeus rake -T
48 zeus runner omg.rb
49
50 ## Hacking
51
c1b43bb @burke Slight improvements to ruby docs
authored
52 To add/modify commands, see [`docs/ruby/modifying.md`](/burke/zeus/tree/master/docs/ruby/modifying.md).
53
54 To get started hacking on Zeus itself, see [`docs/overview.md`](/burke/zeus/tree/master/docs/overview.md).
47622a4 @burke Contributing doc placeholder
authored
55
56 See also the handy contribution guide at [`docs/contributing.md`](/burke/zeus/tree/master/docs/contributing.md).
Something went wrong with that request. Please try again.