Skip to content

Commit

Permalink
Update README: install, --server, Windows support
Browse files Browse the repository at this point in the history
  • Loading branch information
reid committed Dec 9, 2010
1 parent 56e5209 commit 91d1af4
Showing 1 changed file with 15 additions and 20 deletions.
35 changes: 15 additions & 20 deletions README.md
Expand Up @@ -33,7 +33,7 @@ Server mode!

You can also run Yeti as a server:

$ yeti
$ yeti --server
Yeti will only serve files inside /Users/reid
Visit http://localhost:8000, then run:
yeti <test document>
Expand Down Expand Up @@ -102,42 +102,37 @@ You can then visit that URL on your mobile (or any other) device and have it run
Caveats
-------

Yeti is currently only tested on Mac OS X. However, you can run tests on any platform: just run Yeti in server mode and point the browser on another OS to your Yeti server. Yeti should work on other platforms as well, especially in server mode. Feel free to submit patches: see the Contribute section below.
Yeti is known to work on:

- Mac OS X
- Windows in server mode, see [Yeti on Windows][win]
- RHEL 5 in server mode

Yeti should work on other platforms as well, especially in server mode. Feel free to submit patches: see the Contribute section below.

You can run tests on any platform: just run Yeti in server mode and point the browser on another OS to your Yeti server.

You must start Yeti in server mode in the directory you'll be serving tests from. For security reasons, Yeti will reject requests that try to access files outside of the directory you start Yeti in.

Installation
------------

This is experimental software. Use at your own risk. For now, we've only tested the installation process on Mac OS X.

### Recommended Install
This is experimental software. Use at your own risk.

If you have [npm][] installed, this will be easy.

$ npm install yeti@stable
$ npm install yeti

Otherwise, install [npm][] first.

If you want to run off the latest code, clone this project and then run make.

$ git clone git://github.com/reid/yeti.git && cd yeti && make

This will install [homebrew][], [node][] and [npm][] for you if you don't have them installed already.

Installing [localtunnel][] helps proxy Yeti outside of your firewall. It's available as a Ruby gem:

$ gem install localtunnel

### Native Mac Install

A fancy native installer is available if you're using a modern Mac. You will need:

* Mac OS X 10.6 or later
* An Intel Core 2 processor or better

Check out [GitHub Downloads on reid/yeti][dl] for the installer.

The native installer is limited to modern configurations because it ships with all dependencies pre-built. If you have a different configuration, please install with the recommended install method.

Bugs & Feedback
---------------

Expand Down Expand Up @@ -169,7 +164,7 @@ Your contributions are welcome! Please review the [YUI contributor guide][CLA] b
[homebrew]: http://github.com/mxcl/homebrew
[node]: http://nodejs.org/
[npm]: http://npmjs.org/
[dl]: http://github.com/reid/yeti/downloads
[win]: https://github.com/reid/yeti/wiki/Yeti-on-Windows
[issues]: http://yuilibrary.com/projects/yeti/newticket
[YUI Labs]: http://yuilibrary.com/labs/
[Vows]: http://vowsjs.org/
Expand Down

0 comments on commit 91d1af4

Please sign in to comment.