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

Merge pull request #178 from finnbear/patch-2

Browse Source 
Fix grammar and consistency of README
This commit is contained in:
Laurent Clouet
2019-03-23 10:37:53 +01:00
committed by GitHub
parent f68be624db cc76b2b117
commit 1b1e1f6da8
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -8,25 +8,25 @@ SheepIt Render Farm Client is an *Open Source* client for the distributed render
## Compilation ## Compilation
You need Java 1.7 or more. (OpenJDK and Oracle are both supported). You will need Java 1.7 or higher. (OpenJDK and Oracle are both supported).
You also need [ant](http://ant.apache.org/). You also need [ant](http://ant.apache.org/).
To create the jar file, simply type `ant` in the project's root directory. To create the jar file, simply type `ant` in the project's root directory.
## Usage ## Usage
Once you have a jar file, you can view the usage by running: Once you have the jar file, you can see how to use it by running:
java -jar bin/sheepit-client.jar --help 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://sandbox.sheepit-renderfarm.com**, and you can use it by passing `-server http://sandbox.sheepit-renderfarm.com` to your invocation of the client. 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://sandbox.sheepit-renderfarm.com**, and you can use it by passing `-server http://sandbox.sheepit-renderfarm.com` to your invocation of the client.
At the command line ui (-ui text / -ui oneLine) you could type in the following commands and press enter to controll the client: At the command line ui (-ui text / -ui oneLine) you could type in the following commands and press enter to control the client:
* status: to get the current status of the client (paused, stoped, ...) * status: get the current status of the client (paused, stoped, etc.)
* priority <n>: to set the renderer process priority * priority <n>: set the renderer process priority
* block: to block the current project * block: block the current project
* pause: pause the client to request new jobs after the current frame has finished to render * pause: pause the client to request new jobs after the current frame has finished to render
* resume: resume the client after it was paused * resume: resume the client after it was paused
* stop: stop the client after the current frame has finished * stop: stop the client after the current frame has finished
* cancel: cancel the stop request * cancel: cancel the stop request
* quit: stops the client directly without finishing the current frame * quit: stop the client directly without finishing the current frame