diff options
| author |   Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-19 22:36:22 +0100 |
|---|---|---|
| committer | Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-20 14:05:20 +0000 |
| commit | f28308bd99381ef5f1e178e2e1f870f245e35873 (patch) | |
| tree | 342190cc9c6f8517f93ef71402cde74190dca26e | |
| parent | 9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff) | |
Adding README file with global repository description
Change-Id: Id8cb8202bfdb8b781cd38d0346462d6b6b100f19
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
| -rw-r--r-- | README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..fcbc08ba --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Introduction +The git repository structure is described in this file. It can also be derived +by scanning the repo itself. The master branch is read only and contains this +README.md file only. + +The repository is organized in several orphaned branches, each one containing +a sub-project. The naming convention naming branches is described in this +document. + +## Branch naming conventions +Project cicn contains several sub-projects. Sub-project *subp* has a master +branch with name origin/subp/master. All commits associated to sub-project +subp will belong to the orphaned branch origin/subp. All branches associated +to subp must be named as subp/branch-name. + +## Sub projects contained in the cicn git repository + +1. cicn-plugin +2. sb-forwarder +3. libicnet +4. cframework +5. ccnxlib +6. http-server +7. viper +8. vicn +9. android-sdk + +## Sub projects description + +Name | Description | Language and style +------------------- | ----------------------- | ------------------- +1. cicn-plugin | VPP forwarder | C GNU style +2. sb-forwarder | socket-based forwarder | C GNU style +3. libicnet | socket API | C++11 Google style +4. cframework | C framework | C GNU style +5. ccnxlibs | CCNx libraries | C GNU style +6. http-server | HTTP server | C++11 Google style +7. viper | Qt/QML video player | C++/QML Qt style +8. vicn | vICN framework | python-3 and bash +9. android-sdk | Android SDK for ICN | cmake + +## Example: + +For sub-project cicn-plugin, the master branch is cicn-plugin/master +that can be cloned as follows: + +$ git clone -b cicn-plugin/master https://gerrit.fd.io/r/cicn cicn-plugin
\ No newline at end of file |