From 310440d558c66a15d08ba7a158bf654567b65341 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gehring?= Date: Wed, 19 Oct 2016 07:07:04 -0700 Subject: README.md added. --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2bf446d --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +### CommonAPI C++ Core Runtime + +##### Copyright +Copyright (C) 2016, Bayerische Motoren Werke Aktiengesellschaft (BMW AG). +Copyright (C) 2016, GENIVI Alliance, Inc. + +This file is part of GENIVI Project IPC Common API C++. +Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements or MPL 2.0. + +##### License +This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, you can obtain one at http://mozilla.org/MPL/2.0/. + +##### CommonAPI C++ Specification and User Guide +The specification document and the user guide can be found in the CommonAPI documentation directory of the CommonAPI-Tools project as AsciiDoc document. A pdf version can be found at https://github.com/GENIVI/capicxx-core-tools/releases. + +##### Further information +https://genivi.github.io/capicxx-core-tools/ + +##### Build Instructions for Linux + +Use CMake to build this library. We assume that your source directory is _common-api-runtime_: + +```bash +$ cd common-api-runtime +$ mkdir build +$ cd build +$ cmake -D CMAKE_INSTALL_PREFIX=/usr/local .. +$ make +$ make install +``` + +You can change the installation directory by the CMake variable _CMAKE_INSTALL_PREFIX_ or you can let it uninstalled (skip the _make install_ command). Please refer to the installation description of the binding runtime how to use uninstalled versions of CommonAPI. + +For further build instructions (build for windows, build documentation, tests etc.) please refer to the CommonAPI tutorial. + -- cgit v1.2.1