-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make readme easier to read on github
This fixes up the formatting to use github flavor markdown.
- Loading branch information
Showing
1 changed file
with
37 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,88 +1,63 @@ | ||
| # Open Roberta: Getting started with an own deployment of the OpenRoberta programming environment. | ||
| *** | ||
| Open Roberta Lab | ||
| ================ | ||
|
|
||
|
|
||
| ### Introduction: ### | ||
| After a fresh git clone you get the **robertalab** project folder. | ||
| It includes everything you need to setup and extend your own browser programming environment. License information is available in the **docs** folder. | ||
|
|
||
| ###### Things you need on your computer: ###### | ||
| Basic toolset: Java 1.7, Maven, Git, Browser | ||
| Getting started with your own deployment of the OpenRoberta programming environment. | ||
|
|
||
| ### Introduction | ||
|
|
||
| Please also check our [wiki](http://wiki.open-roberta.org) for a detailed install instruction, development procedure, coding conventions and further reading. Please also checkout our project [issue tracker](http://jira.open-roberta.org). | ||
| After a fresh git clone you get the **robertalab** project folder. | ||
| It includes everything you need to setup and extend your own browser programming | ||
| environment. License information is available in the **docs** folder. | ||
|
|
||
| ###### Fast installation (maven is taking care): ###### | ||
| *** | ||
| Things you need on your computer: | ||
|
|
||
| Step 1) Compilation | ||
| * Java 1.7 | ||
| * Maven | ||
| * Git | ||
| * Web browser | ||
|
|
||
| *** | ||
| Please also check our [wiki](http://wiki.open-roberta.org) for a detailed install | ||
| instruction, development procedure, coding conventions and further reading. Please | ||
| also checkout our project [issue tracker](http://jira.open-roberta.org). | ||
|
|
||
| ### Fast installation with maven | ||
|
|
||
| ``$ cd /OpenRobertaParent # move from the root folder to the folder of the (maven) parent project`` | ||
| #### Step 1: Clone the repository and compile | ||
|
|
||
| ``$ mvn clean install `` | ||
| git clone git://github.com/OpenRoberta/robertalab.git | ||
| cd robertalab/OpenRobertaParent | ||
| mvn clean install | ||
|
|
||
| Get a coffee! Might take a couple of minutes. | ||
|
|
||
| *** | ||
|
|
||
| A successful build looks like: | ||
|
|
||
| ``[INFO] ---------------------------------------`` | ||
|
|
||
|
|
||
| ``[INFO] Reactor Summary:`` | ||
|
|
||
|
|
||
| ``[INFO] RobertaParent ..................SUCCESS`` | ||
|
|
||
|
|
||
| ``[INFO] OpenRobertaShared ..............SUCCESS`` | ||
|
|
||
| ``[INFO] OpenRobertaServer ..............SUCCESS`` | ||
|
|
||
| ``[INFO] OpenRobertaRuntime .............SUCCESS`` | ||
| [INFO] --------------------------------------- | ||
| [INFO] Reactor Summary: | ||
| [INFO] RobertaParent ..................SUCCESS | ||
| [INFO] OpenRobertaShared ..............SUCCESS | ||
| [INFO] OpenRobertaServer ..............SUCCESS | ||
| [INFO] OpenRobertaRuntime .............SUCCESS | ||
| [INFO] --------------------------------------- | ||
| [INFO] BUILD SUCCESS | ||
|
|
||
| ``[INFO] ---------------------------------------`` | ||
| #### Step 2a: Starting your own server instance using a unix-like shell (on either lin* or win*). | ||
|
|
||
| ``[INFO] BUILD SUCCESS`` | ||
| cd .. # return to the root folder | ||
| ./ora.sh --start # start the server using default properties | ||
|
|
||
| *** | ||
| You can also run `./ora.sh --help` for more options. | ||
|
|
||
| Step 2a) Starting your own server instance, if a unix-like shell is available (on either lin* or win*). | ||
| #### Step 2b: Starting your own server instance without using the shell script | ||
|
|
||
| *** | ||
| cd ../OpenRobertaServer # go to the folder of the server resources and the database | ||
| java -cp target/OpenRobertaServer-1.0.0-SNAPSHOT.jar de.fhg.iais.roberta.main.ServerStarter # start | ||
|
|
||
| ``$ cd .. # return to the root folder`` | ||
|
|
||
| #### Step 3: Accessing your programming environment | ||
|
|
||
| ``$ ./ora.sh --start # start the server, using default properties. Use --help for more options.`` | ||
| Start your browser at: http://localhost:1999 | ||
|
|
||
| *** | ||
|
|
||
| *** | ||
|
|
||
| Step 2b) Starting your own server instance, without using the shell script | ||
|
|
||
| *** | ||
|
|
||
| ``$ cd .. # return to the root folder`` | ||
|
|
||
| ``$ cd OpenRobertaServer # go to the folder of the server resources and the database`` | ||
|
|
||
| ``$ java -cp target/OpenRobertaServer-1.0.0-SNAPSHOT.jar de.fhg.iais.roberta.main.ServerStarter # start`` | ||
|
|
||
| *** | ||
|
|
||
| ###### Accessing your programming environment: ###### | ||
| Start your browser at: | ||
|
|
||
| `` http://localhost:1999`` | ||
|
|
||
| *** | ||
|
|
||
| That's it! | ||
|
|
||
| *** |