IGNITE-2305: Fix for README.txt Signed-off-by: Anton Vinogradov <a...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/4f2c7517 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/4f2c7517 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/4f2c7517 Branch: refs/heads/ignite-961 Commit: 4f2c75177cc6e7c06b30f66ec20397ae59fea6bb Parents: cdda4b5 Author: isapego <isap...@gridgain.com> Authored: Mon Dec 28 15:42:07 2015 +0300 Committer: Anton Vinogradov <a...@apache.org> Committed: Mon Dec 28 15:50:40 2015 +0300 ---------------------------------------------------------------------- modules/platforms/cpp/DEVNOTES.txt | 35 ++++---------------------- modules/platforms/cpp/README.txt | 44 ++++++++++++++++++++++++++++++++- 2 files changed, 48 insertions(+), 31 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/4f2c7517/modules/platforms/cpp/DEVNOTES.txt ---------------------------------------------------------------------- diff --git a/modules/platforms/cpp/DEVNOTES.txt b/modules/platforms/cpp/DEVNOTES.txt index c97d04c..9a09333 100644 --- a/modules/platforms/cpp/DEVNOTES.txt +++ b/modules/platforms/cpp/DEVNOTES.txt @@ -38,18 +38,6 @@ Building the library: NOTE: "make install" command may require superuser privileges. In this case it must be executed as "sudo make install". -Development: - - * IGNITE_HOME environment variable must be set to Ignite installation directory. - * Once both libraries are built and installed, required headers are placed in the - "/usr/local/include/ignite" directory. - * Apache Ignite C++ depends on jni.h file located inside ${JAVA_HOME}/include directory. - Add this directory to headers search path: "-I${JAVA_HOME}/include". - * Library is placed in the "/usr/local/lib" directory. Link it to your project: "-lignite". - * Ignite depends on "libjvm.so" library shipped with Java. Typically this library is located inside - $JAVA_HOME/jre/lib/amd64/server directory. Ensure that LD_LIBRARY_PATH environment variable points to this directory. - - Building on Windows with Visual Studio (tm) ---------------------------------- @@ -60,25 +48,12 @@ Common Requirements: * Java Development Kit (JDK) must be installed: https://java.com/en/download/index.jsp * JAVA_HOME environment variable must be set pointing to Java installation directory. -Building the library: +Building binaries: * Open and build %IGNITE_HOME%\platforms\cpp\project\vs\ignite.sln (or ignite_86.sln if you are running 32-bit platform). -Development: - - * IGNITE_HOME environment variable must be set to Ignite installation directory. - * Update Include Directories in Project Properties with paths to: - * $(IGNITE_HOME)\platforms\cpp\core\include - * $(IGNITE_HOME)\platforms\cpp\core\os\win\include - * $(IGNITE_HOME)\platforms\cpp\common\include - * $(IGNITE_HOME)\platforms\cpp\common\os\win\include - * $(JAVA_HOME)\include - * $(JAVA_HOME)\include\win32 - * Update Library Directories with path to the built binaries - * Update Linker\Input\Additional Dependencies in Project Properties with path to - * ignite.common.lib - * ignite.core.lib - * Make sure that your application is aware about ignite.common.dll and ignite.core.dll libraries. The easiest way - to achieve this is to either make sure these files are in %PATH%, or to put them into the output directory of - your project with help of PostBuild events. \ No newline at end of file +Building in later versions of Visual Studio: + * Open project\vs\ignite.sln or project\vs\ignite_86.sln in Visual Studio + * You will be prompted to "Update VC++ Compiler and Libraries", click "Update" + * Build the solution. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/4f2c7517/modules/platforms/cpp/README.txt ---------------------------------------------------------------------- diff --git a/modules/platforms/cpp/README.txt b/modules/platforms/cpp/README.txt index 74dec60..e542c82 100644 --- a/modules/platforms/cpp/README.txt +++ b/modules/platforms/cpp/README.txt @@ -18,8 +18,50 @@ Support for the following will be added in next releases: Full source code is provided. Users should build the library for intended platform. -Output files list: +Linux info +============== + +Files list: + + * ignite - executable to start standalone Ignite C++ node. + * libignite.so - Ignite C++ API library. + +Development: + + * IGNITE_HOME environment variable must be set to Ignite installation directory. + * Once both libraries are built and installed, required headers are placed in the + "/usr/local/include/ignite" directory. + * Apache Ignite C++ depends on jni.h file located inside ${JAVA_HOME}/include directory. + Add this directory to headers search path: "-I${JAVA_HOME}/include". + * Library is placed in the "/usr/local/lib" directory. Link it to your project: "-lignite". + * Ignite depends on "libjvm.so" library shipped with Java. Typically this library is located inside + $JAVA_HOME/jre/lib/amd64/server directory. Ensure that LD_LIBRARY_PATH environment variable points to this directory. + * To start Apache Ignite as a standalone node or Windows service use ignite + + +Windows info +=============== + +Files list: * ignite.exe - executable to start standalone Ignite C++ node. * ignite.core.dll - Ignite C++ API library. + +Development: + * IGNITE_HOME environment variable must be set to Ignite installation directory. + * Update Include Directories in Project Properties with paths to: + * $(IGNITE_HOME)\platforms\cpp\core\include + * $(IGNITE_HOME)\platforms\cpp\core\os\win\include + * $(IGNITE_HOME)\platforms\cpp\common\include + * $(IGNITE_HOME)\platforms\cpp\common\os\win\include + * $(JAVA_HOME)\include + * $(JAVA_HOME)\include\win32 + * Update Library Directories with path to the built binaries + * Update Linker\Input\Additional Dependencies in Project Properties with path to + * ignite.common.lib + * ignite.core.lib + * Make sure that your application is aware about ignite.common.dll and ignite.core.dll libraries. The easiest way + to achieve this is to either make sure these files are in %PATH%, or to put them into the output directory of + your project with help of PostBuild events. + * To start Apache Ignite as a standalone node or Windows service use ignite.exe \ No newline at end of file