summaryrefslogtreecommitdiff
path: root/qpid/cpp/README.md
diff options
context:
space:
mode:
authorJustin Ross <jross@apache.org>2016-04-20 00:02:02 +0000
committerJustin Ross <jross@apache.org>2016-04-20 00:02:02 +0000
commita835fb2724824dcd8a470fb51424cedeb6b38f62 (patch)
tree48e5d8591c0029ac500330bf87b78bf9a99ed238 /qpid/cpp/README.md
parentda7718ef463775acc7d6fbecf2d64c1bbfc39fd8 (diff)
downloadqpid-python-a835fb2724824dcd8a470fb51424cedeb6b38f62.tar.gz
QPID-7207: Rename and relocate files inside the cpp subtree
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1740034 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/README.md')
-rw-r--r--qpid/cpp/README.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/qpid/cpp/README.md b/qpid/cpp/README.md
new file mode 100644
index 0000000000..ba13a9f5ff
--- /dev/null
+++ b/qpid/cpp/README.md
@@ -0,0 +1,59 @@
+<!--
+
+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.
+
+-->
+
+# Qpid C++
+
+## Introduction
+
+Qpid C++ is a C++ implementation of the AMQP protocol described at
+<http://amqp.org/>.
+
+For additional software or information on the Qpid project go to:
+
+> <http://qpid.apache.org>
+
+For documentation, go to:
+
+> <http://qpid.apache.org/documentation>
+
+## Available documentation
+
+ - INSTALL.txt - How to install Qpid C++
+ - LICENSE.txt - The Apache license
+ - NOTICE.txt - Corresponds to the section 4 d of the Apache License,
+ Version 2.0
+ - docs/ - Feature and design notes, other documentation
+
+## Quick start
+
+In C++ distributions:
+
+ mkdir BLD # The recommended way to use cmake is in a separate
+ # build directory
+ cd BLD
+ cmake .. # Generates code and makefiles
+ make test # Runs tests
+ make install # Installs the client and daemon
+
+The INSTALL.txt notes contain more detailed information on compiling
+and installing this software.
+
+qpid/cpp/examples/README.txt describes the C++ client API examples.