shithub: openh264

--- a/README.md

+++ b/README.md

@@ -55,38 +55,37 @@

 For Android Builds

 ------------------

-To build for android platform, You need to install android sdk and ndk. You also need to export **ANDROID_SDK**/tools to PATH. On Linux, this can be done by

+To build for android platform, You need to install android sdk and ndk. You also need to export `**ANDROID_SDK**/tools` to PATH. On Linux, this can be done by

-'export PATH=**ANDROID_SDK**/tools:$PATH'

+    export PATH=**ANDROID_SDK**/tools:$PATH

 The codec and demo can be built by

-'make OS=android NDKROOT=**ANDROID_NDK** TARGET= **ANDROID_TARGET**'

+    make OS=android NDKROOT=**ANDROID_NDK** TARGET=**ANDROID_TARGET**

-Valid **ANDROID_TARGET** can be found in **ANDROID_SDK**/platforms, such as android-12.

-You can also set ARCH, NDKLEVEL according to your device and NDK version.

-ARCH specifies the architecture of android device. Currently only arm and x86 are supported, the default is arm.

-NDKLEVEL specifies android api level, the api level can be 12-19, the default is 12.

+Valid `**ANDROID_TARGET**` can be found in `**ANDROID_SDK**/platforms`, such as `android-12`.

+You can also set `ARCH`, `NDKLEVEL` according to your device and NDK version.

+`ARCH` specifies the architecture of android device. Currently `arm`, `arm64`, `x86` and `x86_64` are supported, the default is `arm`. (`mips` and `mips64` can also be used, but there's no specific optimization for those architectures.)

+`NDKLEVEL` specifies android api level, the api level can be 12-19, the default is 12.

-By default these commands build for the armeabi-v7a ABI. To build for the other android

-ABIs, add "ARCH=arm64", "ARCH=x86", "ARCH=x86_64", "ARCH=mips" or "ARCH=mips64".

-To build for the older armeabi ABI (which has armv5te as baseline), add "APP_ABI=armeabi" (ARCH=arm is implicit).

+By default these commands build for the `armeabi-v7a` ABI. To build for the other android

+ABIs, add `ARCH=arm64`, `ARCH=x86`, `ARCH=x86_64`, `ARCH=mips` or `ARCH=mips64`.

+To build for the older `armeabi` ABI (which has armv5te as baseline), add `APP_ABI=armeabi` (`ARCH=arm` is implicit).

 For iOS Builds

 --------------

 You can build the libraries and demo applications using xcode project files

-located in codec/build/iOS/dec and codec/build/iOS/enc.

+located in `codec/build/iOS/dec` and `codec/build/iOS/enc`.

 You can also build the libraries (but not the demo applications) using the

 make based build system from the command line. Build with

-'make OS=ios ARCH=**ARCH**'

+    make OS=ios ARCH=**ARCH**

-Valid values for **ARCH** are the normal iOS architecture names such as

-armv7, armv7s, arm64, and i386 and x86_64 for the simulator. Additionally,

-one might need to add 'SDK=X.Y' to the make command line in case the default

-SDK version isn't available. Another settable iOS specific parameter

-is SDK_MIN, specifying the minimum deployment target for the built library.

+Valid values for `**ARCH**` are the normal iOS architecture names such as

+`armv7`, `armv7s`, `arm64`, and `i386` and `x86_64` for the simulator.

+Another settable iOS specific parameter

+is `SDK_MIN`, specifying the minimum deployment target for the built library.

 For other details on building using make on the command line, see

 'For All Platforms' below.

@@ -95,40 +94,40 @@

 Our Windows builds use MinGW which can be found here - http://www.mingw.org/

-To build with gcc, add the MinGW bin directory (e.g. /c/MinGW/bin) to your path and follow the 'For All Platforms' instructions below.

+To build with gcc, add the MinGW bin directory (e.g. `/c/MinGW/bin`) to your path and follow the 'For All Platforms' instructions below.

 To build with Visual Studio you will need to set up your path to run cl.exe.  The easiest way is to start MSYS from a developer command line session - http://msdn.microsoft.com/en-us/library/ms229859(v=vs.110).aspx  If you need to do it by hand here is an example from a Windows 64bit install of VS2012:

-export PATH="$PATH:/c/Program Files (x86)/Microsoft Visual Studio 11.0/VC/bin:/c/Program Files (x86)/Microsoft Visual Studio 11.0/Common7/IDE"

+    export PATH="$PATH:/c/Program Files (x86)/Microsoft Visual Studio 11.0/VC/bin:/c/Program Files (x86)/Microsoft Visual Studio 11.0/Common7/IDE"

 You will also need to set your INCLUDE and LIB paths to point to your VS and SDK installs.  Something like this, again from Win64 with VS2012 (note the use of Windows-style paths here).

-export INCLUDE="C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\include;C:\Program Files (x86)\Windows Kits\8.0\Include\um;C:\Program Files (x86)\Windows Kits\8.0\Include\shared"

-export LIB="C:\Program Files (x86)\Windows Kits\8.0\Lib\Win8\um\x86;C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\lib"

+    export INCLUDE="C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\include;C:\Program Files (x86)\Windows Kits\8.0\Include\um;C:\Program Files (x86)\Windows Kits\8.0\Include\shared"

+    export LIB="C:\Program Files (x86)\Windows Kits\8.0\Lib\Win8\um\x86;C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\lib"

-Then add 'OS=msvc' to the make line of the 'For All Platforms' instructions.

+Then add `OS=msvc` to the make line of the 'For All Platforms' instructions.

 For All Platforms

 -------------------

 From the main project directory:

-'make' for automatically detecting 32/64bit and building accordingly

-'make ENABLE64BIT=No' for 32bit builds

-'make ENABLE64BIT=Yes' for 64bit builds

-'make V=No' for a silent build (not showing the actual compiler commands)

+- `make` for automatically detecting architecture and building accordingly

+- `make ARCH=i386` for x86 32bit builds

+- `make ARCH=x86_64` for x86 64bit builds

+- `make V=No` for a silent build (not showing the actual compiler commands)

-The command line programs h264enc and h264dec will appear in the main project directory.

+The command line programs `h264enc` and `h264dec` will appear in the main project directory.

-A shell script to run the command-line apps is in testbin/CmdLineExample.sh

+A shell script to run the command-line apps is in `testbin/CmdLineExample.sh`

-Usage information can be found in testbin/CmdLineReadMe

+Usage information can be found in `testbin/CmdLineReadMe`

 Using the Source

 ----------------

-codec - encoder, decoder, console (test app), build (makefile, vcproj)

-build - scripts for Makefile build system.

-test - GTest unittest files.

-testbin - autobuild scripts, test app config files

-res - yuv and bitstream test files

+- `codec` - encoder, decoder, console (test app), build (makefile, vcproj)

+- `build` - scripts for Makefile build system.

+- `test` - GTest unittest files.

+- `testbin` - autobuild scripts, test app config files

+- `res` - yuv and bitstream test files

 Known Issues

 ------------

@@ -141,4 +140,4 @@

 License

 -------

-BSD, see LICENSE file for details.

+BSD, see `LICENSE` file for details.