From e47b87d6e1ea27bf78242cb0bd27e11287603ca9 Mon Sep 17 00:00:00 2001 From: Gautier Pelloux-Prayer Date: Thu, 15 Oct 2015 16:44:55 +0200 Subject: [PATCH] prepare.py: update README --- README.md | 6 +++--- prepare.py | 23 +++++++++-------------- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3dfdc0228..3aa492dce 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ You can also choose to enable/disable features one by one (custom audio/video co You can for instance enable X264 by using: - ./prepare.py -DENABLE_X264=ON [other options] + ./prepare.py -DENABLE_NON_FREE_CODECS=ON -DENABLE_X264=ON [other options] ## Built architectures @@ -74,7 +74,7 @@ After the SDK is built, just open the Linphone Xcode project with Xcode, and pre The liblinphone SDK is compiled with third parties code that are subject to patent license, specially: AMR, SILK G729 and H264 codecs. Linphone controls the embedding of these codecs by generating dummy libraries when there are not available. You can enable them using `prepare.py` - script (see `--enable-non-free-codecs` option). Before embedding these 4 codecs in the final application, **make sure to have the right to do so**. + script (see `--enable-non-free-codecs` option). Before embedding patent codecs in the final application, **make sure to have the right to do so**. # Testing the application @@ -85,7 +85,7 @@ Simply press `⌘U` and the default simulator / device will launch and try to pa # Limitations and known bugs -* Video capture will not work in simulator (not implemented in it). +* Video capture will not work in simulator (simulator limitation). # Debugging the SDK diff --git a/prepare.py b/prepare.py index aca19f628..91ddcfcba 100755 --- a/prepare.py +++ b/prepare.py @@ -362,35 +362,30 @@ zipres: help-prepare-options: \t@echo "prepare.py was previously executed with the following options:" -\t@echo " {options}" +\t@echo "\t{options}" help: help-prepare-options \t@echo "" \t@echo "(please read the README.md file first)" \t@echo "" \t@echo "Available architectures: {archs}" -\t@echo "Available packages: {packages}" \t@echo "" -\t@echo "Available targets:" +\t@echo "=== Available targets ===" \t@echo "" -\t@echo " * all or build: builds all architectures and creates the liblinphone SDK" -\t@echo " * sdk: creates the liblinphone SDK. Use this only after a full build" +\t@echo " * all or build (default): builds all architectures and creates the liblinphone SDK." +\t@echo " * dev: rebuilds liblinphone for all architectures. You must invoke 'sdk' target after this." +\t@echo " * sdk: creates the liblinphone SDK. Use this only after a full build." \t@echo " * zipsdk: generates a ZIP archive of liblinphone-sdk/apple-darwin containing the SDK. Use this only after SDK is built." -\t@echo " * zipres: creates a tar.gz file with all the resources (images)" +\t@echo " * zipres: creates a tar.gz file with all the resources (images)." \t@echo "" \t@echo "=== Advanced usage ===" \t@echo "" -\t@echo " * build-[package]: builds the package for all architectures" -\t@echo " * clean-[package]: cleans package compilation for all architectures" -\t@echo " * veryclean-[package]: cleans the package for all architectures" -\t@echo "" -\t@echo " * [{arch_opts}]-build-[package]: builds a package for the selected architecture" -\t@echo " * [{arch_opts}]-clean-[package]: cleans package compilation for the selected architecture" -\t@echo " * [{arch_opts}]-veryclean-[package]: cleans the package for the selected architecture" +\t@echo " * [{arch_opts}]-build: rebuilds everything for a single architecture. You must invoke 'sdk' target after this." +\t@echo " * [{arch_opts}]-dev: rebuilds liblinphone for a single architecture. You must invoke 'sdk' target after this." \t@echo "" """.format(archs=' '.join(platforms), arch_opts='|'.join(platforms), first_arch=platforms[0], options=' '.join(sys.argv), - arch_targets=arch_targets, packages=' '.join(packages), + arch_targets=arch_targets, multiarch=multiarch, generator=generator) f = open('Makefile', 'w') f.write(makefile)