You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by sa...@apache.org on 2016/03/28 19:45:16 UTC
[09/50] [abbrv] incubator-geode git commit: GEODE-874: Move build
instructions to BUILDING and update README
GEODE-874: Move build instructions to BUILDING and update README
Place all build-from-source instructions into file BUILDING.md, update
the README.md file to tell people to look in the BUILDING.md file if
appropriate, update the Geode-In-5-Minutes to not include building
instructions, and remove irrelevant files COMPILING.txt and RUNNING.txt
from the repo.
Reword the README.md claim that Geode can do rolling updates between
major versions, as there are no major versions, and we can't make
promises about the future.
This closes #114
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/0a9771eb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/0a9771eb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/0a9771eb
Branch: refs/heads/feature/GEODE-52
Commit: 0a9771eb548f5bdb087c45e1c3052d9ee6c675c1
Parents: 4cb83d7
Author: Karen Miller <km...@pivotal.io>
Authored: Tue Mar 15 17:04:33 2016 -0700
Committer: Dan Smith <up...@apache.org>
Committed: Fri Mar 25 14:44:38 2016 -0700
----------------------------------------------------------------------
BUILDING.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
COMPILING.txt | 22 -------------------
README.md | 18 +++++++--------
RUNNING.txt | 23 --------------------
4 files changed, 73 insertions(+), 54 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0a9771eb/BUILDING.md
----------------------------------------------------------------------
diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..ababe2b
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,64 @@
+# Building this Release from Source
+
+Build instructions differ slightly for Unix and Windows platforms.
+All platforms require a Java installation, with JDK 1.8 or more recent version.
+
+## Build from Source on Unix
+
+1. Set the JAVA\_HOME environment variable. For example:
+
+ ```
+ JAVA_HOME=/usr/java/jdk1.8.0_60
+ export JAVA_HOME
+ ```
+2. Download the project source from the Releases page at [Apache Geode (incubating)] (http://geode.incubator.apache.org), and unpack the source code.
+3. Within the directory containing the unpacked source code, build without the tests:
+
+ ```
+ $ ./gradlew build -Dskip.tests=true
+ ```
+Or, build with the tests:
+
+ ```
+ $ ./gradlew build
+ ```
+The built binaries will be in `geode-assembly/build/distributions/`,
+or the `gfsh` script can be found in
+`geode-assembly/build/install/apache-geode/bin/`.
+4. Verify the installation by invoking `gfsh` to print version information and exit:
+
+ ```
+ $ gfsh version
+ v1.0.0-incubating
+ ```
+
+## Build from Source on Windows
+
+1. Set the JAVA\_HOME environment variable. For example:
+
+ ```
+ $ set JAVA_HOME="C:\Program Files\Java\jdk1.8.0_60"
+ ```
+2. Install Gradle, version 2.3 or a more recent version.
+3. Download the project source from the Releases page at [Apache Geode (incubating)] (http://geode.incubator.apache.org), and unpack the source code.
+4. Within the folder containing the unpacked source code, build without the tests:
+
+ ```
+ $ gradle build -Dskip.test=true
+ ```
+Or, build with the tests:
+
+ ```
+ $ gradle build
+ ```
+The built binaries will be in `geode-assembly\build\distributions\`,
+or the `gfsh.bat` script can be found in
+`geode-assembly\build\install\apache-geode\bin\`.
+4. Verify the installation by invoking `gfsh` to print version information and exit:
+
+ ```
+ $ gfsh.bat version
+ v1.0.0-incubating
+ ```
+
+
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0a9771eb/COMPILING.txt
----------------------------------------------------------------------
diff --git a/COMPILING.txt b/COMPILING.txt
deleted file mode 100644
index f2d1098..0000000
--- a/COMPILING.txt
+++ /dev/null
@@ -1,22 +0,0 @@
-To build with gradle, just run
-
-./gradlew build
-
-This will create the binary artifacts and run all of the tests but
-if for some reason you want to skip running the tests include -Dskip.tests=true on the gradle invocation. For example:
-
-./gradlew build -Dskip.tests=true
-
-To create a distribution run
-
-./gradlew distTar
-
-or
-
-./gradlew distZip
-
-the distribution archives will be located in geode-assembly/build/distributions/.
-
-To create an unzipped distribution run
-
-./gradlew installDist
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0a9771eb/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
old mode 100755
new mode 100644
index e78b077..bf6dfb4
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
**[Overview](#overview)**
**[Main Concepts and Components](#concepts)**
+**[Location of Directions for Building from Source](#building)**
**[Geode in 5 minutes](#started)**
**[Application Development](#development)**
**[Documentation](http://geode.docs.pivotal.io/)**
@@ -36,19 +37,18 @@ Apache Geode includes the following features:
* Cluster-wide configurations that can be persisted and exported to other clusters.
* Remote cluster management through HTTP.
* REST APIs for REST-enabled application development.
-* Rolling upgrade between major version releases.
+* Rolling upgrades may be possible, but they will be subject to any limitations imposed by new features.
-## <a name="started"></a>Geode in 5 minutes
+## <a name="building"></a>Building this Release from Source
-With both a recent version of Gradle and JDK 1.8 or a more recent version installed, obtain the source archive.
-Extract the source archive and build from the expanded directory:
+Directions to build Apache Geode (incubating) from source are in the source distribution, file `BUILDING.md`.
- $ gradle build installDist -Dskip.tests=true
+## <a name="started"></a>Geode in 5 minutes
-Start a locator and server:
+With a JDK version 1.8 or a more recent version installed,
+start a locator and server:
- $ cd geode-assembly/build/install/apache-geode
- $ ./bin/gfsh
+ $ gfsh
gfsh> start locator --name=locator
gfsh> start server --name=server
@@ -90,7 +90,7 @@ Compile and run `HelloWorld.java`. The classpath should include `geode-dependen
## <a name="development"></a>Application Development
-Apache Geode applications can be written in a number of client technologies:
+Apache Geode applications can be written in these client technologies:
* Java using the Geode client API or embedded using the Geode peer API
* [Spring Data GemFire](http://projects.spring.io/spring-data-gemfire/) or [Spring Cache](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/cache.html)
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/0a9771eb/RUNNING.txt
----------------------------------------------------------------------
diff --git a/RUNNING.txt b/RUNNING.txt
deleted file mode 100755
index 616b2f1..0000000
--- a/RUNNING.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-Create a distribution archive using
-
-./gradlew distTar
-
-Unpack the archive found in geode-assembly/build/distributions and run the gfsh shell
-
-cd apache-geode-*
-bin/gfsh
-
-OR
-
-Unpack the archive using Gradle task
-
-./gradlew installDist
-
-cd build/install/gemfire
-bin/gfsh
-
-From the gfsh shell you can start a locator and a server using
-
-gfsh> start locator --name=locator
-gfsh> start server --name=server
-