From e198d25ac168198d93bceea0a6be3f093720772d Mon Sep 17 00:00:00 2001 From: AGSPhoenix Date: Wed, 6 Jan 2016 09:44:47 -0500 Subject: [PATCH] Clean up README language Cleaned up some odd wording, consolidated website link into Overview section, and spelled out how to use the dev server. --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 288dcf8..1df257c 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,19 @@ # SheepIt Render Farm Client -## Website - -[SheepIt RenderFarm](https://www.sheepit-renderfarm.com) - ## 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 -You need Java 1.7, OpenJDK or Oracle are supported. -You also need ant. -To create the jar file, simply type "ant". +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 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 -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. \ No newline at end of file