Commit 31437918 authored by Ignacio (Nacho) Solis's avatar Ignacio (Nacho) Solis

Updated README

parent ba39db2c
Libccnx-transport-rta
=======
The CCNx RTA Stack implementation
CCNx Transport RTA Stack
==========
## Quick Start ##
```
$ git clone git@github.com:PARC/Libccnx-transport-rta.git Libccnx-transport-rta
$ mkdir Libccnx-transport-rta.build
$ cd Libccnx-transport-rta.build
$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Libccnx-transport-rta
$ make
$ make test
$ make install
```
## Introduction ##
This is a CCNx Stack implementation
The CCNx Transport RTA stack is a CCNx networking base stack. It is meant to be used with a forwarder running underneath it (See [Metis](https://github.com/PARC/Metis) or [Athena](https://github.com/PARC/Athena)) and a set of APIs above it (see [Portal](https://github.com/PARC/Libccnx-portal)).
## Using Libccnx-transport-rta ##
### Distillery ###
Libccnx-transport-rta is part of [CCNx Distillery](https://github.com/PARC/CCNx_Distillery). You may want to get the software via that distribution if you want to work on CCNx.
### Platforms ###
Libccnx-transport-rta has been tested in:
- Ubuntu 14.04 (x86_64)
- MacOSX 10.10
- MacOSX 10.11
Other platforms and architectures may work.
### Dependencies ###
Build dependencies:
- c99 ( clang / gcc )
- CMake 3.4
Basic dependencies:
- OpenSSL
- pthreads
- Libevent
- [LongBow](https://github.com/PARC/LongBow)
- [Libparc](https://github.com/PARC/Libparc)
- [Libccnx-common](https://github.com/PARC/Libccnx-common)
## Overview ##
Documentation dependencies:
For a full CCNx software distribution please look at the CCNx Distillery
https://github.com/PARC/CCNx_Distillery
- Doxygen
## Dependencies ##
This library depends on LongBow.
- https://github.com/PARC/LongBow
- https://github.com/PARC/Libparc
- https://github.com/PARC/Libccnx-common
### Getting Started ###
## Getting Started ##
Libccnx-transport-rta is built using cmake. You will need to have CMake 3.4 installed in order to build it.
Build and install LongBow by executing
```
mkdir build
cd build
cmake ..
make
make install
make test
Download Libccnx-transport-rta
$ git clone git@github.com:PARC/Libccnx-transport-rta.git Libccnx-transport-rta
Create build directory
$ mkdir Libccnx-transport-rta.build
$ cd Libccnx-transport-rta.build
Prepare the build, give an install directory
$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Libccnx-transport-rta
Compile the software
$ make
Run unit tests
$ make test
Install the software
$ make install
```
This will create the `include` and `lib` directories containing the necessary files to compile with LongBow in the `${INSTALL_DIR}`.
### 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>
This will create the `include` and `lib` directories containing the necessary files to compile with LongBow.
-I${CCNX_HOME}/include -L${CCNX_HOME}/lib -lccnx_transport_rta -lccnx_api_notify -lccnx_api_control
```
### Contact ###
Please see http://www.ccnx.org/
- [Libccnx-transport-rta GitHub](https://github.com/PARC/Libccnx-transport-rta)
- [CCNx Website](http://www.ccnx.org/)
- [CCNx Mailing List](https://www.ccnx.org/mailman/listinfo/ccnx/)
### License ###
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment