generic-library/openh264
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adjust README.md to use proper markdown styling

Browse Source
This commit is contained in:
Martin Storsjö 2015-03-13 12:50:05 +02:00
parent 60f6f13d7e
commit 36360c521d
1 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -55,38 +55,38 @@ To build the arm assembly for Windows Phone, gas-preprocessor is required. It ca
For Android Builds 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 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. 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. 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. `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. `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 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". 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). To build for the older `armeabi` ABI (which has armv5te as baseline), add `APP_ABI=armeabi` (`ARCH=arm` is implicit).
For iOS Builds For iOS Builds
-------------- --------------
You can build the libraries and demo applications using xcode project files 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 You can also build the libraries (but not the demo applications) using the
make based build system from the command line. Build with 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 Valid values for `**ARCH**` are the normal iOS architecture names such as
armv7, armv7s, arm64, and i386 and x86_64 for the simulator. Additionally, `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 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 SDK version isn't available. Another settable iOS specific parameter
is SDK_MIN, specifying the minimum deployment target for the built library. 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 other details on building using make on the command line, see
'For All Platforms' below. 'For All Platforms' below.
@ -95,7 +95,7 @@ For Windows Builds
Our Windows builds use MinGW which can be found here - http://www.mingw.org/ 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: 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:
@ -106,29 +106,29 @@ You will also need to set your INCLUDE and LIB paths to point to your VS and SDK
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 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 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 For All Platforms
------------------- -------------------
From the main project directory: From the main project directory:
'make' for automatically detecting 32/64bit and building accordingly - `make` for automatically detecting 32/64bit and building accordingly
'make ENABLE64BIT=No' for 32bit builds - `make ENABLE64BIT=No` for 32bit builds
'make ENABLE64BIT=Yes' for 64bit builds - `make ENABLE64BIT=Yes` for 64bit builds
'make V=No' for a silent build (not showing the actual compiler commands) - `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 Using the Source
---------------- ----------------
codec - encoder, decoder, console (test app), build (makefile, vcproj) - `codec` - encoder, decoder, console (test app), build (makefile, vcproj)
build - scripts for Makefile build system. - `build` - scripts for Makefile build system.
test - GTest unittest files. - `test` - GTest unittest files.
testbin - autobuild scripts, test app config files - `testbin` - autobuild scripts, test app config files
res - yuv and bitstream test files - `res` - yuv and bitstream test files
Known Issues Known Issues
------------ ------------
@ -141,4 +141,4 @@ See the issue tracker on https://github.com/cisco/openh264/issues
License License
------- -------
BSD, see LICENSE file for details. BSD, see `LICENSE` file for details.