ref: 3e4c6382451ffa5a835d7464dfa58464a6e5e9fb
parent: 284861b3bcb9f977cc5d47b9eaf0d77b73375d9a
parent: 529bcf83cc23b9927cfc4ffe97a8c45317ba2d17
author: ruil2 <ruil2@cisco.com>
date: Wed Nov 2 05:29:56 EDT 2016
Merge pull request #2581 from rwhitworth/documentation README.md updates
--- a/README.md
+++ b/README.md
@@ -51,8 +51,8 @@
Building the Library
--------------------
-NASM needed to be installed for assembly code: workable version 2.10.06 or above, nasm can downloaded from http://www.nasm.us/
-For Mac OSX 64-bit NASM needed to be below version 2.11.08 as nasm 2.11.08 will introduce error when using RIP-relative addresses in Mac OSX 64-bit
+NASM needed to be installed for assembly code: workable version 2.10.06 or above, NASM can downloaded from http://www.nasm.us/.
+For Mac OSX 64-bit NASM needed to be below version 2.11.08 as NASM 2.11.08 will introduce error when using RIP-relative addresses in Mac OSX 64-bit
To build the arm assembly for Windows Phone, gas-preprocessor is required. It can be downloaded from git://git.libav.org/gas-preprocessor.git
@@ -96,11 +96,11 @@
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 downloaded from 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 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. Instructions can be found at 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"
@@ -111,7 +111,7 @@
Then add `OS=msvc` to the make line of the 'For All Platforms' instructions.
-For Windows Phone builds
+For Windows Phone Builds
------------------------
Follow the instructions above for normal Windows builds, but use `OS=msvc-wp`
@@ -128,10 +128,10 @@
-------------------
From the main project directory:
- `make` for automatically detecting architecture and building accordingly
-- `make ARCH=i386` for x86 32bit builds
-- `make ARCH=x86_64` for x86 64bit builds
+- `make ARCH=i386` for x86 32-bit builds
+- `make ARCH=x86_64` for x86 64-bit builds
- `make V=No` for a silent build (not showing the actual compiler commands)
-- `make DEBUGSYMBOLS=True` for two libraries, one is normal libraries, another one is removed the debugging symbol table entries (those created by the -g option )
+- `make DEBUGSYMBOLS=True` for two libraries, one is normal libraries, another one is removed the debugging symbol table entries (those created by the -g option)
The command line programs `h264enc` and `h264dec` will appear in the main project directory.
@@ -142,8 +142,8 @@
Using the Source
----------------
- `codec` - encoder, decoder, console (test app), build (makefile, vcproj)
-- `build` - scripts for Makefile build system.
-- `test` - GTest unittest files.
+- `build` - scripts for Makefile build system
+- `test` - GTest unittest files
- `testbin` - autobuild scripts, test app config files
- `res` - yuv and bitstream test files