aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md78
1 files changed, 33 insertions, 45 deletions
diff --git a/README.md b/README.md
index c60b1d4d..58f14085 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,4 @@
-#############################################################################
-# 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.
-##############################################################################
-
-Android SDK
+##Android SDK
This is the CCNx Distillery software distribution for Android. It is in charge of pulling
together all the necessary modules to build a full CCNx software suite for Android.
@@ -73,7 +58,7 @@ make all
The CCNx software will be installed in androidSdk/usr
-To compile Metis for android app (ccnxandroidmetis)
+To compile Metis for android app (ccnxandroidmetis)
```
make android_metis
@@ -111,35 +96,38 @@ execute. You will basically want to download all the sources and compile.
Here's a short summary:
-- `make update` - git pull the different modules to the head of master"
-- `make all` - Download sdk, ndk and dependencies, configure, compile and install all software in DISTILLERY_INSTALL_DIR"
-- `make init_depend` - Download sdk, ndk and dependencies, compile and install all dependencies in DISTILLERY_INSTALL"
-- `make install-all` - Configure, compile and install all software in DISTILLERY_INSTALL_DIR"
-- `curl-clean` - Clean curl files and libs"
-- `boost-clean` - Clean boost files and libs"
-- `openssl-clean` - Clean opennssl files and libs"
-- `crystax-clean` - Clean crystax files and libs"
-- `event-clean` - Clean libevent files and libs"
-- `crystaxndk-clean` - Clean crystax ndk files"
-- `xml2-clean` - Clean libxml2 files and libs"
-- `dependencies-clean` - Clean all dependencies files and libs"
-- `sdk-clean` - Clean sdk files"
-- `ndk-clean` - Clean ndk files"
-- `cmake-clean` - Clean cmake files"
-- `androidsdk-clean` - Clean sdk, ndk and cmake files"
-- `cframework-clean` - Clean cframework (libparc and longbow) files and libs"
-- `ccnxlibs-clean` - Clean ccnxlibs files and libs"
-- `sb-forwarder-clean` - Clean sb-forwarder (metis) files and libs"
-- `libicnet-clean` - Clean libicnet files and libs"
-- `libdash-clean` - Clean libdash files and libs"
-- `all-clean` - Clean all files and libs"
-- `android_metis` - Build metis apk for android"
-- `android_metis_debug` - Build metis apk for android in debug mode"
-- `android_iget` - Build iGet apk for android apk in debug mode"
-- `android_iget_debug` - Build iGet apk for android apk"
+- `make update` - git pull the different modules to the head of master
+- `make all` - Download sdk, ndk, qt environment and dependencies, configure, compile and install all software in DISTILLERY_INSTALL_DIR
+- `make init_depend` - Download sdk, ndk and dependencies, compile and install all dependencies in DISTILLERY_INSTALL
+- `make init_qt` - Download qt environnment, compile and install all dependencies in DISTILLERY_ROOT/qt
+- `make install-all` - Configure, compile and install all software in DISTILLERY_INSTALL_DIR
+- `curl-clean` - Clean curl files and libs
+- `boost-clean` - Clean boost files and libs
+- `openssl-clean` - Clean opennssl files and libs
+- `crystax-clean` - Clean crystax files and libs
+- `event-clean` - Clean libevent files and libs
+- `crystaxndk-clean` - Clean crystax ndk files
+- `xml2-clean` - Clean libxml2 files and libs
+- `dependencies-clean` - Clean all dependencies files and libs
+- `sdk-clean` - Clean sdk files
+- `ndk-clean` - Clean ndk files
+- `cmake-clean` - Clean cmake files
+- `androidsdk-clean` - Clean sdk, ndk and cmake files
+- `cframework-clean` - Clean cframework (libparc and longbow) files and libs
+- `ccnxlibs-clean` - Clean ccnxlibs files and libs
+- `sb-forwarder-clean` - Clean sb-forwarder (metis) files and libs
+- `libicnet-clean` - Clean libicnet files and libs
+- `libdash-clean` - Clean libdash files and libs
+- `qt-clean` - Clean qt environment files and libs
+- `all-clean` - Clean all files and libs
+- `android_metis` - Build metis apk for android
+- `android_metis_debug` - Build metis apk for android in debug mode
+- `android_iget` - Build iGet apk for android
+- `android_iget_debug` - Build iGet apk for android in debug mode
+- `android_viper` - Build Viper apk for android
+- `android_iget_debug` - Build Viper apk for android in debug mode
## Configuration ##
-Distillery can be configured in multiple ways. Please check the config directory (specifically `config/config.mk`) for more information.
-
+Distillery can be configured in multiple ways. Please check the config directory (specifically `config/config.mk`) for more information. \ No newline at end of file