Merge pull request #19 from ricardoquesada/readme_fixes

minor fixes in readme

Author: ricardoquesada

README.md

@@ -71,20 +71,24 @@ We have one build script for each platform, they are under `build` directory.
 All of them share the same usage:
 
 ```
-./build.sh -p=param0 --libs=param1 --arch=param2 --mode=param3 --list
+./build.sh -p=platform --libs=libs --arch=arch --mode=mode --list
 ```
 
-- param0: specify a platform, only (ios, mac, android, linux and tizen ) are valid values.
+- platform: specify a platform. Supported platforms: ios, mac, android, linux and tizen
 
-- param1:
-    - use `all` to build all the 3rd party libraries, it will take you a very long time.
-    - use comma separated library names, for example, `png,lua,jpeg,webp`,  no space between the comma.
+  libs:
+    - use `all` to build all the 3rd party libraries.
+    - use comma separated library names, for example, `png,lua,jpeg,webp`, no space between the comma to select one or more libs
 
-- param2:
-    - use `all` to build all the supported arches. For iOS, they are "armv7, arm64, i386, x86_64", for Android, they are "arm,armv7,arm64,x86", for Mac, they are "x86_64", for Tizen, they are "armv7"
+  arch:
+    - use `all` to build all the supported architectures.
+    - for iOS, they are "armv7, arm64, i386, x86_64"
+    - for Android, they are "arm,armv7,arm64,x86"
+    - for Mac, they are "x86_64"
+    - for Tizen, they are "armv7"
     - use comma separated arch name, for example, `armv7, arm64`, no space between the comma.
 
-- param3:
+- mode:
     - release:  Build library on release mode. This is the default option. We use `-O3 -DNDEBUG` flags to build release library.
     - debug:  Build library on debug mode. we use `-O0 -g -DDEBUG` flag to build debug library.
 

build/build.sh

@@ -165,7 +165,7 @@ if [ $cfg_platform_name = "android" ];then
         echo "Invalid gcc version number! Gcc version should be numerical numbers."
         usage
         exit 1
-    fi 
+    fi
 
 fi
 
@@ -295,7 +295,7 @@ do
 
         #set build mode flags -- debug or release
         set_build_mode_cflags
-        
+
 
         install_library_path="install-${cfg_platform_name}"
         build_library_path=$cfg_platform_name
@@ -307,7 +307,7 @@ do
         if [ -z $original_arch_name ];then
             original_arch_name=$arch
         fi
-        
+
         MY_TARGET_ARCH=$original_arch_name
         export MY_TARGET_ARCH
 
@@ -328,7 +328,7 @@ do
 
         fi
 
-        
+
         mkdir -p "${top_dir}/contrib/${cfg_platform_name}-${arch}"
         cd "${top_dir}/contrib/${cfg_platform_name}-${arch}"
 
@@ -344,20 +344,20 @@ do
                      --host=${!my_target_host} \
                      --prefix=${PREFIX}
 
-        
+
         echo "MY_TARGET_ARCH := ${MY_TARGET_ARCH}" >> config.mak
         echo "OPTIM := ${OPTIM}" >> config.mak
-        
+
         make
 
-        cd -    
-  
+        cd -
+
         local_library_install_path=$cfg_platform_name/$archive_name/prebuilt/$original_arch_name
         if [ ! -d $local_library_install_path ]; then
             echo "create folder for library with specify arch. $local_library_install_path"
             mkdir -p $local_library_install_path
         fi
-        
+
         #determine the .a achive name with a specified libraries
         parse_original_lib_name=${lib}_original_name
         original_archive_name=${!parse_original_lib_name}
@@ -373,7 +373,7 @@ do
         original_dependent_archive_list=${!parse_dependent_archive_list}
         if [ ! -z $original_dependent_archive_list ];then
             echo "copying dependent archives..."
-            original_dependent_archive_list=(${original_dependent_archive_list//,/ })            
+            original_dependent_archive_list=(${original_dependent_archive_list//,/ })
 
             for dep_archive in ${original_dependent_archive_list[@]}
             do
@@ -399,18 +399,18 @@ do
 
     echo $cfg_build_fat_library
     if [ $cfg_build_fat_library = "yes" ];then
-        
+
         create_fat_library $archive_name
 
         parse_dependent_archive_list=${lib}_dependent_archive_list
         original_dependent_archive_list=${!parse_dependent_archive_list}
         if [ ! -z $original_dependent_archive_list ];then
             echo "create fat library for dependent archives..."
-            original_dependent_archive_list=(${original_dependent_archive_list//,/ })            
+            original_dependent_archive_list=(${original_dependent_archive_list//,/ })
 
             for dep_archive in ${original_dependent_archive_list[@]}
             do
-                create_fat_library $dep_archive                
+                create_fat_library $dep_archive
             done
         fi
     fi