From ec688b4723a041044226358bcd4dd6e2da39da49 Mon Sep 17 00:00:00 2001
From: Luca Muscariello <lumuscar+fdio@cisco.com>
Date: Thu, 23 Feb 2017 17:01:02 +0100
Subject: Initial commit: cframework. Longbow and Libparc

Change-Id: I90378dbd30da6033b20fb1f829b3b822cf366c59
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
---
 libparc/README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 libparc/README.md

(limited to 'libparc/README.md')

diff --git a/libparc/README.md b/libparc/README.md
new file mode 100644
index 00000000..818435f6
--- /dev/null
+++ b/libparc/README.md
@@ -0,0 +1,94 @@
+Libparc
+=======
+The PARC C Library
+
+
+## Quick Start ##
+```
+
+$ git clone -b cframework/master https://gerrit.fd.io/r/cicn cframework
+$ cd cframework/libparc
+$ mkdir build
+$ cd build
+$ cmake ..
+or, for MacOSX 10.12, you need to speficy openssl root folder 
+$ cmake .. -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/
+$ make
+$ make test
+$ make install
+```
+
+## Introduction ##
+
+The PARC Library is a C runtime providing an array of features and capabilities for C programs and programmers.
+
+Functionality is grouped into:
+
+* Data structures
+* Input Output
+* Memory and Buffer Management
+* Threading and Concurrency
+* Security
+* Developer Aids
+* Networking and Communication
+
+## Using Libparc ##
+
+### Platforms ###
+
+Libparc 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
+
+Documentation dependencies:
+
+- Doxygen
+
+
+### Using Libparc ###
+
+Libparc 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 libparc library.
+
+```
+LIBPARC=<directory-where-libparc-is-installed>
+
+-I${LIBPARC}/include -L${LIBPARC}/lib -lparc
+```
+
+
+### 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.
+```
-- 
cgit 1.2.3-korg