|
1 | 1 | Metis |
2 | 2 | ======= |
| 3 | +A CCNx forwarder |
3 | 4 |
|
4 | | -The Metis CCNx Forwarder |
5 | | -========== |
| 5 | +## Quick Start ## |
| 6 | +``` |
| 7 | +$ git clone git@github.com:PARC/Metis.git Metis |
| 8 | +$ mkdir Metis.build |
| 9 | +$ cd Metis.build |
| 10 | +$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Metis |
| 11 | +$ make |
| 12 | +$ make test |
| 13 | +$ make install |
| 14 | +``` |
6 | 15 |
|
7 | 16 | ## Introduction ## |
8 | 17 |
|
9 | | -This is a CCNx forwarder |
| 18 | +Metis is a CCNx Forwarder. |
| 19 | + |
| 20 | +## Using Metis ## |
| 21 | + |
| 22 | +### Distillery ### |
| 23 | + |
| 24 | +Metis 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. |
| 25 | + |
| 26 | +### Platforms ### |
| 27 | + |
| 28 | +Metis has been tested in: |
| 29 | + |
| 30 | +- Ubuntu 14.04 (x86_64) |
| 31 | +- MacOSX 10.10 |
| 32 | +- MacOSX 10.11 |
| 33 | + |
| 34 | +Other platforms and architectures may work. |
| 35 | + |
| 36 | +### Dependencies ### |
| 37 | + |
| 38 | +Build dependencies: |
| 39 | + |
| 40 | +- c99 ( clang / gcc ) |
| 41 | +- CMake 3.4 |
| 42 | + |
| 43 | +Basic dependencies: |
10 | 44 |
|
11 | | -## Overview ## |
| 45 | +- OpenSSL |
| 46 | +- pthreads |
| 47 | +- Libevent |
| 48 | +- [LongBow](https://github.com/PARC/LongBow) |
| 49 | +- [Libparc](https://github.com/PARC/Libparc) |
| 50 | +- [Libccnx-common](https://github.com/PARC/Libccnx-common) |
| 51 | +- [Libccnx-transport-rta](https://github.com/PARC/Libccnx-transport-rta) |
12 | 52 |
|
13 | | -For a full CCNx software distribution please look at the CCNx Distillery |
14 | | -https://github.com/PARC/CCNx_Distillery |
15 | 53 |
|
16 | | -## Dependencies ## |
| 54 | +Documentation dependencies: |
17 | 55 |
|
18 | | -This library depends on LongBow. |
19 | | -- https://github.com/PARC/LongBow |
20 | | -- https://github.com/PARC/Libparc |
21 | | -- https://github.com/PARC/Libccnx-common |
22 | | -- https://github.com/PARC/Libccnx-transport-rta |
| 56 | +- Doxygen |
23 | 57 |
|
24 | | -## Getting Started ## |
25 | 58 |
|
26 | | -Build and install LongBow by executing |
| 59 | +### Getting Started ### |
| 60 | + |
| 61 | +Metis is built using cmake. You will need to have CMake 3.4 installed in order to build it. |
| 62 | + |
27 | 63 | ``` |
28 | | -mkdir build |
29 | | -cd build |
30 | | -cmake .. |
31 | | -make |
32 | | -make install |
33 | | -make test |
| 64 | +Download Metis |
| 65 | +$ git clone git@github.com:PARC/Metis.git Metis |
| 66 | +
|
| 67 | +Create build directory |
| 68 | +$ mkdir Metis.build |
| 69 | +$ cd Metis.build |
| 70 | +
|
| 71 | +Prepare the build, give an install directory |
| 72 | +$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Metis |
| 73 | +
|
| 74 | +Compile the software |
| 75 | +$ make |
| 76 | +
|
| 77 | +Run unit tests |
| 78 | +$ make test |
| 79 | +
|
| 80 | +Install the software |
| 81 | +$ make install |
34 | 82 | ``` |
35 | 83 |
|
36 | | -This will create the `include` and `lib` directories containing the necessary files to compile with LongBow. |
| 84 | +This will place the Metis binaries in the `bin` directory of `${INSTALL_DIR}`. |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | +### Using Metis ### |
| 89 | + |
| 90 | +Metis is a set of binary executables that are used to run a CCNx forwarder instance. Please refer to the Metis documentation for detailed information. You can also try the -h flags of the executables |
| 91 | + |
| 92 | +- `metis_daemon -h` |
| 93 | +- `metis_control -h` |
37 | 94 |
|
38 | 95 | ### Contact ### |
39 | 96 |
|
40 | | -Please see http://www.ccnx.org/ |
| 97 | +- [Metis GitHub](https://github.com/PARC/Metis) |
| 98 | +- [CCNx Website](http://www.ccnx.org/) |
| 99 | +- [CCNx Mailing List](https://www.ccnx.org/mailman/listinfo/ccnx/) |
| 100 | + |
41 | 101 |
|
42 | 102 | ### License ### |
43 | 103 |
|
|
0 commit comments