README.md

# SheepIt Render Farm Client

## Overview

SheepIt Render Farm Client is an *Open Source* client for the distributed render farm [**SheepIt**](https://www.sheepit-renderfarm.com).

## Compilation

You need Java 1.7. OpenJDK and Oracle are both supported.
You also need [ant](http://ant.apache.org/).
To create the jar file, simply type `ant` in the project's root directory.

## Usage

Once you have a jar file, you can view the usage by running:

    java -jar bin/sheepit-client.jar --help

When you are doing development work, you can use a mirror of the main site specially made for demo/dev. The mirror is located at **http://www-demo.sheepit-renderfarm.com**, and you can use it by passing `-server http://www-demo.sheepit-renderfarm.com` to your invocation of the client.
Update README.md 2014-11-19 19:06:16 +00:00			`# SheepIt Render Farm Client`
Initial commit 2014-11-19 16:03:05 +00:00
Update README.md 2014-11-19 19:06:16 +00:00			`## Overview`

Clean up README language Cleaned up some odd wording, consolidated website link into Overview section, and spelled out how to use the dev server. 2016-01-06 09:44:47 -05:00			`SheepIt Render Farm Client is an Open Source client for the distributed render farm [SheepIt](https://www.sheepit-renderfarm.com).`
Update README.md 2014-11-19 19:06:16 +00:00
			`## Compilation`

Clean up README language Cleaned up some odd wording, consolidated website link into Overview section, and spelled out how to use the dev server. 2016-01-06 09:44:47 -05:00			`You need Java 1.7. OpenJDK and Oracle are both supported.`
			`You also need [ant](http://ant.apache.org/).`
			To create the jar file, simply type `ant` in the project's root directory.
Update README.md 2014-11-19 19:06:16 +00:00
			`## Usage`

Clean up README language Cleaned up some odd wording, consolidated website link into Overview section, and spelled out how to use the dev server. 2016-01-06 09:44:47 -05:00			`Once you have a jar file, you can view the usage by running:`
Updated README.md Made the example command line usage use code formatting instead of quotes to avoid confusion for new users. 2015-10-20 20:37:42 -07:00
			`java -jar bin/sheepit-client.jar --help`

Clean up README language Cleaned up some odd wording, consolidated website link into Overview section, and spelled out how to use the dev server. 2016-01-06 09:44:47 -05:00			When you are doing development work, you can use a mirror of the main site specially made for demo/dev. The mirror is located at http://www-demo.sheepit-renderfarm.com, and you can use it by passing `-server http://www-demo.sheepit-renderfarm.com` to your invocation of the client.