From 78aff479d89cf617860b36e0ecfffbda6b9a7e69 Mon Sep 17 00:00:00 2001 From: Rui Gu Date: Sat, 8 Dec 2018 11:55:54 +0000 Subject: [PATCH] added a section explaining building branch --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ff70c80c..3c39a9366 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,11 @@ Have at least a local copy of built redis, for more information see [tutorial](h Note that redis shouldn't be running - the build will start instances as needed. + +## Choosing the building branch +Prior to the build, you may need to change branch depending on which version of Redisson you want to build. Currently master branch is for version 2.x whereas 3.0.0 branch is for 3.x branch. Version 2.x requies Java SDK 6 and above and version 3.x requires Java SDK 8 and above to build. + + ## Running the tests ## ``` bash @@ -10,4 +15,4 @@ export REDIS_BIN= # And finally running the build mvn -DargLine="-Xmx2g -DredisBinary=$REDIS_BIN/redis-server" -Punit-test clean test -e -X -``` \ No newline at end of file +```