summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorJürgen Gehring <juergen.gehring@bmw.de>2015-06-11 06:57:47 -0700
committerJürgen Gehring <juergen.gehring@bmw.de>2015-06-11 06:57:47 -0700
commit6c463fcc3dcee619925f08ea09e19a86b9e581cc (patch)
tree17e765e0623c58778150605d1cd0340c658ce6ab /INSTALL
parent1d83eb38e546e0165f1ad6821f04445b2b9b19d2 (diff)
downloadgenivi-common-api-runtime-6c463fcc3dcee619925f08ea09e19a86b9e581cc.tar.gz
CommonAPI 3.1.1
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL43
1 files changed, 43 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..991f46a
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,43 @@
+= IPC CommonAPI C++
+
+:doctitle: IPC CommonAPI C++
+:version:
+
+== Copyright
+Copyright (C) 2015, Bayerische Motoren Werke Aktiengesellschaft (BMW AG).
+Copyright (C) 2015, 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/.
+
+== Version
+{version}
+
+== 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.
+
+== Further information
+Source code and latest news can be found at http://projects.genivi.org/commonapi/.
+
+== Build Instructions for Linux
+
+Use CMake to build this library. We assume that your source directory is +common-api-runtime+:
+
+----
+$ 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.
+
+