diff options
author | Michele Papalini <micpapal+fdio@cisco.com> | 2017-02-24 08:00:13 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2017-02-24 08:00:13 +0000 |
commit | 6d4b6878ceff22f9ec8d8e9423214f9666007472 (patch) | |
tree | fa27e0c747676519cb87ff8448bfed62fce5009d /libccnx-transport-rta/README.md | |
parent | f28308bd99381ef5f1e178e2e1f870f245e35873 (diff) | |
parent | d18ae43123fcd7604d1c36a1ec8450dbe6071824 (diff) |
Merge "Initial commit: ccnxlibs." into ccnxlibs/master
Diffstat (limited to 'libccnx-transport-rta/README.md')
-rw-r--r-- | libccnx-transport-rta/README.md | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/libccnx-transport-rta/README.md b/libccnx-transport-rta/README.md new file mode 100644 index 00000000..94ec9eb4 --- /dev/null +++ b/libccnx-transport-rta/README.md @@ -0,0 +1,87 @@ +Libccnx-transport-rta +======= +The CCNx RTA Stack implementation + +## Quick Start ## +``` +$ git clone -b ccnxlibs/master https://gerrit.fd.io/r/cicn ccnxlibs +$ cd ccnxlibs/libccnx-transport-rta +$ mkdir build +$ cd build +$ cmake .. +$ make +$ make test +$ make install +``` + +## Introduction ## + +The CCNx Transport RTA stack is a CCNx networking base stack. + +## Using Libccnx-transport-rta ## + +### Platforms ### + +Libccnx-transport-rta has been tested in: + +- Ubuntu 16.04 (x86_64) +- Debian Testing +- MacOSX 10.12 + +Other platforms and architectures may work. + +### Dependencies ### + +Build dependencies: + +- c99 ( clang / gcc ) +- CMake 3.4 + +Basic dependencies: + +- OpenSSL +- pthreads +- Libevent +- LongBow +- Libparc +- Libccnx-common + +``` +$ git clone -b cframework/master https://gerrit.fd.io/r/cicn cframework; +$ git clone -b ccnxlibs/master https://gerrit.fd.io/r/cicn ccnxlibs; +``` +- +Documentation dependencies: + +- Doxygen + +### Using Libccnx-transport-rta ### + +Libccnx-transport-rta is a set of functions and data structures for C. You can use it in your code by including the right header files and linking to the Libccnx-transport-rta library. + +``` +CCNX_HOME=<directory-where-Libccnx-transport-rta-is-installed> + +-I${CCNX_HOME}/include -L${CCNX_HOME}/lib -lccnx_transport_rta -lccnx_api_notify -lccnx_api_control +``` + +### License ### + +This software is distributed under the following license: + +``` + Copyright (c) 2017 Cisco and/or its affiliates. + Licensed 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. + + +``` |