[geode-native] branch develop updated: GEODE-4804: [Docs] “How to Install” page - working draft based on BUILDING.md

[db...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git


The following commit(s) were added to refs/heads/develop by this push:
     new b336e3a  GEODE-4804: [Docs] “How to Install” page - working draft based on BUILDING.md
b336e3a is described below

commit b336e3ac27fb2fe7cee1c9174bf11bdcf806d16a
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Tue Mar 20 15:32:48 2018 -0700

    GEODE-4804: [Docs] “How to Install” page - working draft based on BUILDING.md
---
 docs/geode-native-docs/building.html.md.erb | 145 ++++++++++++++++++++++++++++
 1 file changed, 145 insertions(+)

diff --git a/docs/geode-native-docs/building.html.md.erb b/docs/geode-native-docs/building.html.md.erb
new file mode 100644
index 0000000..f829b25
--- /dev/null
+++ b/docs/geode-native-docs/building.html.md.erb
@@ -0,0 +1,145 @@
+<% set_title("Building the", product_name_long, "Native Client") %>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+## Prerequisites (All Platforms)
+* [CMake 3.10](https://cmake.org/) or newer
+* C++11 compiler *(see platform specific requirements)*
+* [Doxygen 8.11](http://www.stack.nl/~dimitri/doxygen/download.html) *(for building source documentation)*
+* [Apache Geode](http://geode.apache.org/releases/) binaries installed or available to link against
+
+Building requires access to an installation of Geode. By default the value of `GEODE_ROOT` or
+`GEODE` is used during CMake configuration if either of those shell variables is exported. To
+explicitly specify the location in which Geode is installed, add `-DGEODE_ROOT=/path/to/geode` to
+the _initial_ `cmake` execution command.
+
+### Platform-Specific Prerequisites
+* [Mac OS X](#mac-os-x)
+* [Linux](#linux)
+* [Solaris](#solaris)
+* [Windows](#windows)
+
+## Steps to build
+
+    $ cd <clone>
+    $ mkdir build
+    $ cd build
+    $ cmake .. <platform-specific generator parameters (see below)>
+    $ cmake --build . -- <platform-specific parallelism parameters (see below)>
+
+### Generator
+CMake uses a "generator" to produce configuration files for use by a variety of build tools, e.g.,
+UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake
+during configuration. (Please see [the CMake documentation](https://cmake.org/documentation/) for
+further information.) However, in many cases there is a better choice.
+
+#### CLion / Eclipse / Other
+The recommended generator for most unix platforms is 'Makefiles' (default):
+
+	$ cmake .. 
+
+#### Xcode
+The recommended generator for Xcode is `Xcode`:
+
+	$ cmake .. -G "Xcode"
+
+#### Windows / Visual Studio
+When running cmake commands on Windows, be sure to use [Visual Studio Native Tools Command
+Prompt](https://msdn.microsoft.com/en-us/library/f35ctcxw.aspx) so environment variables are set
+properly.
+
+The recommended generator on Windows is `Visual Studio 14 2015 Win64`:
+
+	$ cmake .. -G "Visual Studio 14 2015 Win64" -Thost=x64
+
+### Build Parallelism
+For faster builds, use optional parallelism parameters in the last build step:
+
+#### Unix
+
+	$ cmake --build . -- -j <# of jobs>
+
+#### Windows
+
+	$ cmake --build . -- /m
+
+## Installing
+By default a system-specific location is used by CMake as the destination of the `install` target,
+e.g., `/usr/local` on UNIX system. To explicitly specify the location in which the Native Client
+will be installed, add `-DCMAKE_INSTALL_PREFIX=/path/to/installation/destination` to the _initial_
+`cmake` execution command.
+
+**Note:** For consistent results, avoid using the "~" (tilde) abbreviation when specifying paths on the CMake command line.
+Interpretation of the symbol varies depending on the option being specified, and on the system or command shell in use.
+
+Due to limitations in CMake, the documentation must be built as a separate step before installation:
+
+    $ cd <clone>
+    $ cd build
+    $ cmake --build . --target docs
+    $ cmake --build . --target install
+
+# Platform-Specific Prerequisites
+
+## Mac OS X
+* Mac OS X 10.12 (Sierra) or newer
+* Xcode 8.2 or newer
+
+### Required Tools
+* [Xcode](https://developer.apple.com/xcode/download/)
+* Xcode command line developer tools
+
+    `$ xcode-select --install`
+
+### Optional Tools
+* [CMake GUI](https://cmake.org/)
+* [Doxygen GUI](http://ftp.stack.nl/pub/users/dimitri/Doxygen-1.8.11.dmg)
+* [CLion](https://www.jetbrains.com/clion/)
+
+## Windows
+* Windows 8.1 64-bit
+* Windows 10 64-bit
+* Windows Server 2012 R2 64-bit
+* Windows Server 2016 64-bit
+
+### Required Tools
+* [Visual Studio 2015](https://www.visualstudio.com) or newer
+* .NET 4.5.2 or later
+* Chocolately
+* Other dependencies installed via Powershell
+
+## Linux
+* RHEL/CentOS 6
+* RHEL/CentOS 7
+* SLES 11
+* SLES 12
+
+### Required Tools
+* [GCC 5](https://gcc.gnu.org) or newer
+
+### Optional Tools
+* [Eclipse CDT 8.8](https://eclipse.org/cdt/) or newer
+
+## Solaris
+* Solaris 11 SPARC
+* Solaris 11 x86
+
+### Required Tools
+* [Solaris Studio 12.6](http://www.oracle.com/technetwork/server-storage/developerstudio/downloads/index.html) or newer
+
+

-- 
To stop receiving notification emails like this one, please contact
dbarnes@apache.org.