Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changes to README file #42

Merged
merged 1 commit into from
Oct 3, 2017
Merged

Changes to README file #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 48 additions & 30 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,71 +1,89 @@
# YottaDB

All software in this package is part of YottaDB (http://yottadb.com) each
file of which identifies its copyright holders. The software is made available
to you under the terms of a license. Refer to the LICENSE file for details.
to you under the terms of a license. Refer to the [LICENSE](LICENSE) file for details.

YottaDB relies on CMake to generate the Makefiles to build binaries from source.
The prerequisites are CMake (at least 2.8.5), GNU make (at least 3.81), Linux
(x86_64), libraries and development files for libz, Unicode, OpenSSL and GPG.
Ubuntu 16.04 LTS was used to test the builds for this distribution, with default
versions of packages from the distribution repositories.

To build YottaDB, do the following steps:
## How to build

1. Fulfill the pre-requisites

Install developement libraries
cmake tcsh {libconfig,libelf,libgcrypt,libgpg-error,libgpgme11,libicu,libncurses,libssl,zlib1g}-dev

```sh
cmake tcsh {libconfig,libelf,libgcrypt,libgpg-error,libgpgme11,libicu,libncurses,libssl,zlib1g}-dev
```

There may be other library dependencies or the packages may have different names.
If CMake issues a NOTFOUND error, please see the FAQ below.

2. Unpack the YottaDB sources

The YottaDB source tarball extracts to a directory with the version number in
the name, e.g., YottaDB-r1.10
```sh
$ tar xfz r1.10.tar.gz
$ cd YottaDB-r1.10
```

You should find this README, LICENSE, COPYING and CMakeLists.txt file and
sr_* source directories.

3. Building YottaDB -
<build> can be a sub directory of the source directory,
YottaDB-r1.10, or any other valid path.
3. Building YottaDB

`<build>` can be a sub directory of the source directory,
YottaDB-r1.10, or any other valid path.

```sh
$ mkdir <build>
$ cd <build>

# [optional] If you installed a YottaDB binary distribution, provide the directory path to cmake
# -D GTM_DIST:PATH=$gtm_dist
#
# By default the script creates production (pro) builds of YottaDB. To create
# a debug (dbg) build of YottaDB supply the following parameter to cmake
# -D CMAKE_BUILD_TYPE=Debug # Note: title case is important
#
# Note that the cmake install does not create the final installed YottaDB.
# Instead, it stages YottaDB for distribution. Change the CMAKE_INSTALL_PREFIX
# to place the staged files in a local directory. To install YottaDB, you must
# cd to that installed directory and execute the configure script.
#
# -D CMAKE_INSTALL_PREFIX:PATH=${PWD}/package
#
```

> [OPTIONAL] If you installed a YottaDB binary distribution, provide the directory path to cmake
> `-D GTM_DIST:PATH=$gtm_dist`
>
> By default the script creates production (pro) builds of YottaDB. To create
> a debug (dbg) build of YottaDB supply the following parameter to cmake
> -D CMAKE_BUILD_TYPE=Debug *Note: title case is important*
>
> Note that the cmake install does not create the final installed YottaDB.
> Instead, it stages YottaDB for distribution. Change the CMAKE_INSTALL_PREFIX
> to place the staged files in a local directory. To install YottaDB, you must
> cd to that installed directory and execute the configure script.
>
> `-D CMAKE_INSTALL_PREFIX:PATH=${PWD}/package`
>

```sh
$ cmake -D CMAKE_INSTALL_PREFIX:PATH=${PWD}/package ../

$ make

$ make install

$ cd pro/lib/fis-gtm/V6.3-002_R100_x86_64 # or dbg for debug builds

# Now you are ready to install GT.M. Answer a few questions and install it.
# The recommended installation path is /opt/fis-gtm/V6.3-002_x86_64
$ cd pro/lib/yottadb/V6.3-002_R100_x86_64 # or dbg for debug builds
```

Now you are ready to install YottaDB. Answer a few questions and install it.
The recommended installation path is `/opt/yottadb/V6.3-002_x86_64`

$ sudo ./gtminstall # to install the version you just built
# ./gtminstall --help # get installation options
```sh
$ sudo ./gtminstall # to install the version you just built
# ./gtminstall --help # get installation options

$ cd - ; make clean
$ cd - ; make clean
```
4. Packaging YottaDB

4. Packaging GT.M -
Create a tar file from the installed directory

FAQ:
## FAQ
- The CMake build fails with the following message followed by one or more cases.
CMake Error: The following variables are used in this project, but they are set to NOTFOUND.
Please set them or make sure they are set and tested correctly in the CMake files:
Expand Down