readme.md updates

1 files changed, 69 insertions, 88 deletions

diff --git a/README.md b/README.md
index 0cb9123..cb51a31 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 Google C++ Mocking Framework
 ============================
 
-http://code.google.com/p/googlemock/
+<http://github.com/google/googlemock/>
 
 Overview
 --------
@@ -33,23 +33,22 @@ mailing list for questions, discussions, and development.  There is
 also an IRC channel on OFTC (irc.oftc.net) #gtest available.  Please
 join us!
 
-Please note that code under scripts/generator/ is from the cppclean
-project (http://code.google.com/p/cppclean/) and under the Apache
+Please note that code under scripts/generator/ is from the [cppclean
+project](http://code.google.com/p/cppclean/) and under the Apache
 License, which is different from Google Mock's license.
 
 Requirements for End Users
 --------------------------
 
-Google Mock is implemented on top of the Google Test C++ testing
-framework (http://code.google.com/p/googletest/), and includes the
-latter as part of the SVN repository and distribution package.  You
-must use the bundled version of Google Test when using Google Mock, or
+Google Mock is implemented on top of the [Google Test C++ testing
+framework](http://github.com/google/googletest/), and depends on it.
+You must use the bundled version of Google Test when using Google Mock, or
 you may get compiler/linker errors.
 
 You can also easily configure Google Mock to work with another testing
 framework of your choice; although it will still need Google Test as
 an internal dependency.  Please read
-http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework
+<http://code.google.com/p/googlemock/wiki/ForDummies#Using_Google_Mock_with_Any_Testing_Framework>
 for how to do it.
 
 Google Mock depends on advanced C++ features and thus requires a more
@@ -91,39 +90,19 @@ Getting the Source
 ------------------
 
 There are two primary ways of getting Google Mock's source code: you
-can download a stable source release in your preferred archive format,
-or directly check out the source from our Subversion (SVN) repository.
-The SVN checkout requires a few extra steps and some extra software
+can download a [stable source release](releases),
+or directly check out the source from our Git repository.
+The Git checkout requires a few extra steps and some extra software
 packages on your system, but lets you track development and make
 patches much more easily, so we highly encourage it.
 
-### Source Package ###
+### Git Checkout ###
 
-Google Mock is released in versioned source packages which can be
-downloaded from the download page [1].  Several different archive
-formats are provided, but the only difference is the tools needed to
-extract their contents, and the size of the resulting file.  Download
-whichever you are most comfortable with.
+To check out the master branch of Google Mock, run the following git command:
 
-  [1] http://code.google.com/p/googlemock/downloads/list
+    git clone https://github.com/google/googlemock.git
 
-Once downloaded expand the archive using whichever tools you prefer
-for that type.  This will always result in a new directory with the
-name "gmock-X.Y.Z" which contains all of the source code.  Here are
-some examples on Linux:
-
-  tar -xvzf gmock-X.Y.Z.tar.gz
-  tar -xvjf gmock-X.Y.Z.tar.bz2
-  unzip gmock-X.Y.Z.zip
-
-### SVN Checkout ###
-
-To check out the main branch (also known as the "trunk") of Google
-Mock, run the following Subversion command:
-
-  svn checkout http://googlemock.googlecode.com/svn/trunk/ gmock-svn
-
-If you are using a *nix system and plan to use the GNU Autotools build
+If you are using a \*nix system and plan to use the GNU Autotools build
 system to build Google Mock (described below), you'll need to
 configure it now.  Otherwise you are done with getting the source
 files.
@@ -132,7 +111,7 @@ To prepare the Autotools build system, enter the target directory of
 the checkout command you used ('gmock-svn') and proceed with the
 following command:
 
-  autoreconf -fvi
+    autoreconf -fvi
 
 Once you have completed this step, you are ready to build the library.
 Note that you should only need to complete this step once.  The
@@ -144,7 +123,7 @@ will fail.  You may need to explicitly specify a version to use.  For
 instance, if you have both GNU Automake 1.4 and 1.9 installed and
 'automake' would invoke the 1.4, use instead:
 
-  AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf -fvi
+    AUTOMAKE=automake-1.9 ACLOCAL=aclocal-1.9 autoreconf -fvi
 
 Make sure you're using the same version of automake and aclocal.
 
@@ -161,40 +140,40 @@ straightforward.
 This section shows how you can integrate Google Mock into your
 existing build system.
 
-Suppose you put Google Mock in directory ${GMOCK_DIR} and Google Test
-in ${GTEST_DIR} (the latter is ${GMOCK_DIR}/gtest by default).  To
+Suppose you put Google Mock in directory ${GMOCK\_DIR} and Google Test
+in ${GTEST\_DIR} (the latter is ${GMOCK\_DIR}/gtest by default).  To
 build Google Mock, create a library build target (or a project as
 called by Visual Studio and Xcode) to compile
 
-  ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.cc
+    ${GTEST_DIR}/src/gtest-all.cc and ${GMOCK_DIR}/src/gmock-all.cc
 
 with
 
-  ${GTEST_DIR}/include and ${GMOCK_DIR}/include
+    ${GTEST_DIR}/include and ${GMOCK_DIR}/include
 
 in the system header search path, and
 
-  ${GTEST_DIR} and ${GMOCK_DIR}
+    ${GTEST_DIR} and ${GMOCK_DIR}
 
 in the normal header search path.  Assuming a Linux-like system and gcc,
 something like the following will do:
 
-  g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
-      -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
-      -pthread -c ${GTEST_DIR}/src/gtest-all.cc
-  g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
-      -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
-      -pthread -c ${GMOCK_DIR}/src/gmock-all.cc
-  ar -rv libgmock.a gtest-all.o gmock-all.o
+    g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
+        -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
+        -pthread -c ${GTEST_DIR}/src/gtest-all.cc
+    g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} \
+        -isystem ${GMOCK_DIR}/include -I${GMOCK_DIR} \
+        -pthread -c ${GMOCK_DIR}/src/gmock-all.cc
+    ar -rv libgmock.a gtest-all.o gmock-all.o
 
 (We need -pthread as Google Test and Google Mock use threads.)
 
 Next, you should compile your test source file with
-${GTEST_DIR}/include and ${GMOCK_DIR}/include in the header search
+${GTEST\_DIR}/include and ${GMOCK\_DIR}/include in the header search
 path, and link it with gmock and any other necessary libraries:
 
-  g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \
-      -pthread path/to/your_test.cc libgmock.a -o your_test
+    g++ -isystem ${GTEST_DIR}/include -isystem ${GMOCK_DIR}/include \
+        -pthread path/to/your_test.cc libgmock.a -o your_test
 
 As an example, the make/ directory contains a Makefile that you can
 use to build Google Mock on systems where GNU make is available
@@ -206,13 +185,11 @@ script.
 If the default settings are correct for your environment, the
 following commands should succeed:
 
-  cd ${GMOCK_DIR}/make
-  make
-  ./gmock_test
+    cd ${GMOCK_DIR}/make
+    make
+    ./gmock_test
 
-If you see errors, try to tweak the contents of make/Makefile to make
-them go away.  There are instructions in make/Makefile on how to do
-it.
+If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away.
 
 ### Windows ###
 
@@ -223,11 +200,11 @@ selected tests.
 Change to the appropriate directory and run "msbuild gmock.sln" to
 build the library and tests (or open the gmock.sln in the MSVC IDE).
 If you want to create your own project to use with Google Mock, you'll
-have to configure it to use the gmock_config propety sheet.  For that:
+have to configure it to use the `gmock_config` propety sheet.  For that:
 
  * Open the Property Manager window (View | Other Windows | Property Manager)
  * Right-click on your project and select "Add Existing Property Sheet..."
- * Navigate to gmock_config.vsprops or gmock_config.props and select it.
+ * Navigate to `gmock_config.vsprops` or `gmock_config.props` and select it.
  * In Project Properties | Configuration Properties | General | Additional
    Include Directories, type <path to Google Mock>/include.
 
@@ -238,11 +215,12 @@ Google Mock can be used in diverse environments.  The default
 configuration may not work (or may not work well) out of the box in
 some environments.  However, you can easily tweak Google Mock by
 defining control macros on the compiler command line.  Generally,
-these macros are named like GTEST_XYZ and you define them to either 1
+these macros are named like `GTEST_XYZ` and you define them to either 1
 or 0 to enable or disable a certain feature.
 
 We list the most frequently used macros below.  For a complete list,
-see file ${GTEST_DIR}/include/gtest/internal/gtest-port.h.
+see file [${GTEST\_DIR}/include/gtest/internal/gtest-port.h](
+../googletest/include/gtest/internal/gtest-port.h).
 
 ### Choosing a TR1 Tuple Library ###
 
@@ -259,13 +237,13 @@ you need to tell Google Test and Google Mock to use the same TR1 tuple
 library the rest of your project uses, or the two tuple
 implementations will clash.  To do that, add
 
-  -DGTEST_USE_OWN_TR1_TUPLE=0
+    -DGTEST_USE_OWN_TR1_TUPLE=0
 
 to the compiler flags while compiling Google Test, Google Mock, and
 your tests.  If you want to force Google Test and Google Mock to use
 their own tuple library, just add
 
-  -DGTEST_USE_OWN_TR1_TUPLE=1
+    -DGTEST_USE_OWN_TR1_TUPLE=1
 
 to the compiler flags instead.
 
@@ -277,13 +255,14 @@ it and set it up.
 
 Google Mock is compact, so most users can build and link it as a static
 library for the simplicity.  Google Mock can be used as a DLL, but the
-same DLL must contain Google Test as well.  See Google Test's README
-file for instructions on how to set up necessary compiler settings.
+same DLL must contain Google Test as well.  See
+[Google Test's README][gtest_readme]
+for instructions on how to set up necessary compiler settings.
 
 ### Tweaking Google Mock ###
 
 Most of Google Test's control macros apply to Google Mock as well.
-Please see file ${GTEST_DIR}/README for how to tweak them.
+Please see [Google Test's README][gtest_readme] for how to tweak them.
 
 Upgrading from an Earlier Version
 ---------------------------------
@@ -296,24 +275,24 @@ do if you are upgrading from an earlier version of Google Mock.
 ### Upgrading from 1.1.0 or Earlier ###
 
 You may need to explicitly enable or disable Google Test's own TR1
-tuple library.  See the instructions in section "Choosing a TR1 Tuple
-Library".
+tuple library.  See the instructions in section "[Choosing a TR1 Tuple
+Library](../googletest/#choosing-a-tr1-tuple-library)".
 
 ### Upgrading from 1.4.0 or Earlier ###
 
 On platforms where the pthread library is available, Google Test and
 Google Mock use it in order to be thread-safe.  For this to work, you
 may need to tweak your compiler and/or linker flags.  Please see the
-"Multi-threaded Tests" section in file ${GTEST_DIR}/README for what
-you may need to do.
+"[Multi-threaded Tests](../googletest#multi-threaded-tests
+)" section in file Google Test's README for what you may need to do.
 
-If you have custom matchers defined using MatcherInterface or
-MakePolymorphicMatcher(), you'll need to update their definitions to
-use the new matcher API [2].  Matchers defined using MATCHER() or
-MATCHER_P*() aren't affected.
+If you have custom matchers defined using `MatcherInterface` or
+`MakePolymorphicMatcher()`, you'll need to update their definitions to
+use the new matcher API (
+[monomorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers),
+[polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)).
+Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected.
 
-  [2] http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Monomorphic_Matchers,
-      http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers
 
 Developing Google Mock
 ----------------------
@@ -328,13 +307,13 @@ For that you'll need Autotools.  First, make sure you have followed
 the instructions in section "SVN Checkout" to configure Google Mock.
 Then, create a build output directory and enter it.  Next,
 
-  ${GMOCK_DIR}/configure  # Standard GNU configure script, --help for more info
+    ${GMOCK_DIR}/configure  # Standard GNU configure script, --help for more info
 
 Once you have successfully configured Google Mock, the build steps are
 standard for GNU-style OSS packages.
 
-  make        # Standard makefile following GNU conventions
-  make check  # Builds and runs all tests - all should pass.
+    make        # Standard makefile following GNU conventions
+    make check  # Builds and runs all tests - all should pass.
 
 Note that when building your project against Google Mock, you are building
 against Google Test as well.  There is no need to configure Google Test
@@ -345,25 +324,27 @@ separately.
 Some of Google Mock's source files are generated from templates (not
 in the C++ sense) using a script.  A template file is named FOO.pump,
 where FOO is the name of the file it will generate.  For example, the
-file include/gmock/gmock-generated-actions.h.pump is used to generate
-gmock-generated-actions.h in the same directory.
+file `include/gmock/gmock-generated-actions.h.pump` is used to generate
+`gmock-generated-actions.h` in the same directory.
 
 Normally you don't need to worry about regenerating the source files,
 unless you need to modify them.  In that case, you should modify the
-corresponding .pump files instead and run the 'pump' script (for Pump
+corresponding `.pump` files instead and run the 'pump' script (for Pump
 is Useful for Meta Programming) to regenerate them.  You can find
-pump.py in the ${GTEST_DIR}/scripts/ directory.  Read the Pump manual
-[3] for how to use it.
+pump.py in the `${GTEST_DIR}/scripts/` directory.  Read the
+[Pump manual](http://code.google.com/p/googletest/wiki/PumpManual)
+for how to use it.
 
-  [3] http://code.google.com/p/googletest/wiki/PumpManual.
 
 ### Contributing a Patch ###
 
-We welcome patches.  Please read the Google Mock developer's guide [4]
+We welcome patches.  Please read the [Google Mock developer's Guide](
+http://code.google.com/p/googlemock/wiki/DevGuide)
 for how you can contribute.  In particular, make sure you have signed
 the Contributor License Agreement, or we won't be able to accept the
 patch.
 
-  [4] http://code.google.com/p/googlemock/wiki/DevGuide
 
 Happy testing!
+
+[gtest_readme]: ../googletest/ "googletest"