From 9cefd4dc29d5e47d09c0daca215d8df25e5dd5e9 Mon Sep 17 00:00:00 2001 From: Michael Wei Date: Mon, 11 Apr 2016 15:31:17 -0700 Subject: [PATCH] partially update readme --- README.md | 28 ++++------------------------ 1 file changed, 4 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index c43f35f..2d0f7f8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -# CorfuDB example project +# Corfu example project + +This repository contains a sample project for Corfu, which showcases some basic features of CorfuDB. -This repository contains a sample project for CorfuDB, which showcases some basic features of CorfuDB. -The main source file is located [here](src/main/java/org/corfudb/example/CorfuHelloWorld.java). The code -is well commented and will walk you through how to use CorfuDB. As you navigate through the source code, the [javadoc](http://corfudb.github.io/CorfuDB/javadoc/) may help you, and there is also a [wiki](https://github.com/CorfuDB/CorfuDB/wiki) to guide you through @@ -13,21 +12,13 @@ To build your own CorfuDB project, simply fork this project. ## Building the Project This project uses Maven as a build system. To build this project, you will need to have Java 8 and Maven installed. -Also, until CorfuDB is submitted to Maven central, you will have to build CorfuDB on your system somewhere first -using ```mvn install```, before building this project. On a Ubuntu 14.02 machine, run: ``` # Install prerequisites sudo add-apt-repository ppa:webupd8team/java sudo apt-get update -sudo apt-get install oracle-java8-installer maven git -wget http://people.apache.org/~jfarrell/thrift/0.9.2/contrib/ubuntu/thrift-compiler_0.9.2_amd64.deb -O /tmp/thrift-compiler.deb -sudo dpkg -i /tmp/thrift-compiler.deb -# Clone CorfuDB and build -git clone https://github.com/CorfuDB/CorfuDB.git -cd CorfuDB -mvn install +sudo apt-get install oracle-java8-installer maven # Clone this project and build cd .. git clone https://github.com/CorfuDB/CorfuDB-HelloWorld.git @@ -50,15 +41,4 @@ To run the project, type: bin/corfuHelloWorld.sh run ``` -This will run the project with an in-memory implementation of CorfuDB. -If you want to run the project against a real CorfuDB deployment, you should run with the -m parameter -pointing to a master address. -For example, to run the project against a default CorfuDB deployment, you should run something like: -``` -# go to CorfuDB project directory -cd ../CorfuDB -sudo bin/corfuDBMultiple.sh start -# now run our project -cd ../CorfuDB-HelloWorld -bin/corfuHelloWorld.sh run -m http://localhost:8002/corfu