diff options
Diffstat (limited to 'libccnx-common/README.md')
-rw-r--r-- | libccnx-common/README.md | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/libccnx-common/README.md b/libccnx-common/README.md new file mode 100644 index 00000000..b0deb613 --- /dev/null +++ b/libccnx-common/README.md @@ -0,0 +1,81 @@ +Libccnx-common +======= +The CCNx Common Library + +## Quick Start ## +``` + +$ git clone -b cframework/master https://gerrit.fd.io/r/cicn ccnxlibs +$ cd ccnxlibs/libccnx-common +$ mkdir build +$ cd build +$ cmake .. +$ make +$ make test +$ make install +``` + +## Introduction ## + +The CCNx Common library is a set of functions and data structures for CCNx. + +## Using Libccnx-common ## + +### Platforms ### + +Libccnx-common 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 + + +Documentation dependencies: + +- Doxygen + + +### Using Libccnx-common ### + +Libccnx-common 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-common library. + +``` +CCNX_HOME=<directory-where-Libccnx-common-is-installed> + +-I${CCNX_HOME}/include -L${CCNX_HOME}/lib -lccnx_common +``` + +### 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. +``` |