Raincloud/sheepit-shadow-nabber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #51 from AGSPhoenix/update-readme

Browse Source 
Clean up README language
This commit is contained in:
Laurent Clouet
2016-01-06 17:20:07 +01:00
parent e570adafe6 e198d25ac1
commit 0c794ceb7e
1 changed files with 6 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,26 +1,19 @@
# SheepIt Render Farm Client # SheepIt Render Farm Client
## Website
[SheepIt RenderFarm](https://www.sheepit-renderfarm.com)
## Overview ## Overview
SheepIt Render Farm Client is an *Open Source* client for the distributed render farm "Sheep It". SheepIt Render Farm Client is an *Open Source* client for the distributed render farm [**SheepIt**](https://www.sheepit-renderfarm.com).
## Compilation ## Compilation
You need Java 1.7, OpenJDK or Oracle are supported. You need Java 1.7. OpenJDK and Oracle are both supported.
You also need ant. You also need [ant](http://ant.apache.org/).
To create the jar file, simply type "ant". To create the jar file, simply type `ant` in the project's root directory.
## Usage ## Usage
Once you have a jar file you look at the usage by doing: Once you have a jar file, you can view the usage by running:
java -jar bin/sheepit-client.jar --help java -jar bin/sheepit-client.jar --help
When you are doing your development you can use a mirror of the main site who is specially made for demo/dev, it is located at **http://www-demo.sheepit-renderfarm.com** 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.