Commits

Martijn Verburg committed 396bb50 Merge

Merged in danielbryant_uk/betterrev (pull request #70)

Improved readme.md following on from comments from Saturday's hackday

  • Participants
  • Parent commits 5c003bf, 92999e6

Comments (0)

Files changed (1)

-betterrev
+Betterrev
 =========
 
-A friendly, hosted wrapper around webrevs
+A friendly, hosted wrapper around OpenJDK Contributions and 'webrevs'.
+
+If you already have the Betterrev source code downloaded and configured then please scroll down for more details on configuring your favourite IDE, otherwise please follow the 'Getting started...' instructions directly below.
 
 Getting started for developers
 ------------------------------
 * [Fork the betterrev repository](https://bitbucket.org/adoptopenjdk/betterrev/fork)    
 **WARNING** Untick the **issues** and **wiki** checkboxes, you do not want those!
 
-* Clone your fork onto your local file system:
+* Clone your fork onto your local file system. You have two options to choose from:
+* If you are using bitbucket git via http use the following command:
 
 `git clone https://<your username>@bitbucket.org/<your username>/betterrev.git betterrev_project`
 
+* -OR- If you are using bitbucket git via ssh and have created ssh keys on your local machine use the following command (for more info on this method of interacting with bitbucket please read [this bitbucket wiki article](https://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Git))
+
+`git clone git@bitbucket.org:<your_username>/betterrev.git betterrev_project`
+
 * Clone the adopt repository into the betterrev_project/betterrev directory:
 
 ```
 cd adopt
 hg clone https://bitbucket.org/adoptopenjdk/jdk8 jdk8
 ```
-
-* Your final directory structure should look something like this (the important dirs are **betterrev**, **adopt**, **jdk8**):
+* Get the jdk8 sources:
+    * `$ cd jdk8` 
+    * `$ chmod u+x get_source.sh`
+    * `$ ./get_source.sh`
+* Your final directory structure should look something like the following. There may be directories missing (e.g., bin, logs, target), but the important dirs that you should check are present and in the correct location are **betterrev**, **adopt**, **jdk8**:
 
 ```
 betterrev_project\
         test\
 ```
 
-* Go to the betterrev_project/betterrev directory and type:
+* Go to the betterrev_project/betterrev directory and launch the Play sbt interactive console by typing:
 
-`play run`
+`play`
 
-* Launch [Betterrev](http://localhost:9000/)
+* From the Play Console you can execute the following commands (from within the $SOURCE/betterrev/betterrev/ folder)
+    * `[betterrev] $ compile`
+    * `[betterrev] $ test`
+    * `[betterrev] $ run`
+* The commands should be self-explanatory, and so go ahead and run the Betterrev application
+* Launch [Betterrev](http://localhost:9000/). 
+    * You may see an error page in your browser (and a corresponding stacktrace in the play terminal window) stating something like **Database 'default' needs evolution!**, but this is normal, and you should click the 'Apply this script now!'. Play uses the 'ebean' framework to manage/migrate the database schema (much like the frameworks 'liquibase' or 'flyway'), and this error is simply stating that your database schema needs to be created or updated.
 
 Developing using IntelliJ IDEA 12
 ---------------------------------