Merge pull request #574 from BillyDonahue/undoc

Undoc

1 files changed, 114 insertions, 131 deletions

diff --git a/googlemock/README.md b/googlemock/README.md
index cb51a31a..c4556468 100644
--- a/googlemock/README.md
+++ b/googlemock/README.md
@@ -1,84 +1,121 @@
-Google C++ Mocking Framework
-============================
-
-<http://github.com/google/googlemock/>
-
-Overview
---------
-
-Google's framework for writing and using C++ mock classes on a variety
-of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc).
-Inspired by jMock, EasyMock, and Hamcrest, and designed with C++'s
-specifics in mind, it can help you derive better designs of your
-system and write better tests.
-
-Google Mock:
-
-- provides a declarative syntax for defining mocks,
-- can easily define partial (hybrid) mocks, which are a cross of real
-  and mock objects,
-- handles functions of arbitrary types and overloaded functions,
-- comes with a rich set of matchers for validating function arguments,
-- uses an intuitive syntax for controlling the behavior of a mock,
-- does automatic verification of expectations (no record-and-replay
-  needed),
-- allows arbitrary (partial) ordering constraints on
-  function calls to be expressed,
-- lets a user extend it by defining new matchers and actions.
-- does not use exceptions, and
-- is easy to learn and use.
+## Google Mock ##
+
+The Google C++ mocking framework.
+
+### Overview ###
+
+Google's framework for writing and using C++ mock classes.
+It can help you derive better designs of your system and write better tests.
+
+It is inspired by:
+
+  * [jMock](http://www.jmock.org/),
+  * [EasyMock](http://www.easymock.org/), and
+  * [Hamcrest](http://code.google.com/p/hamcrest/),
+
+and designed with C++'s specifics in mind.
+
+Google mock:
+
+  * lets you create mock classes trivially using simple macros.
+  * supports a rich set of matchers and actions.
+  * handles unordered, partially ordered, or completely ordered expectations.
+  * is extensible by users.
+
+We hope you find it useful!
+
+### Features ###
+
+  * Provides a declarative syntax for defining mocks.
+  * Can easily define partial (hybrid) mocks, which are a cross of real
+    and mock objects.
+  * Handles functions of arbitrary types and overloaded functions.
+  * Comes with a rich set of matchers for validating function arguments.
+  * Uses an intuitive syntax for controlling the behavior of a mock.
+  * Does automatic verification of expectations (no record-and-replay needed).
+  * Allows arbitrary (partial) ordering constraints on
+    function calls to be expressed,.
+  * Lets a user extend it by defining new matchers and actions.
+  * Does not use exceptions.
+  * Is easy to learn and use.
 
 Please see the project page above for more information as well as the
 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
-License, which is different from Google Mock's license.
+Please note that code under [scripts/generator](scripts/generator/) is
+from [cppclean](http://code.google.com/p/cppclean/) and released under
+the Apache License, which is different from Google Mock's license.
+
+## Getting Started ##
+
+If you are new to the project, we suggest that you read the user
+documentation in the following order:
+
+  * Learn the [basics](../googletest/docs/Primer.md) of
+    Google Test, if you choose to use Google Mock with it (recommended).
+  * Read [Google Mock for Dummies](docs/ForDummies.md).
+  * Read the instructions below on how to build Google Mock.
+
+You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation.
+
+Once you understand the basics, check out the rest of the docs:
+
+  * [CheatSheet](googlemock/docs/CheatSheet.md) - all the commonly used stuff
+    at a glance.
+  * [CookBook](googlemock/docs/CookBook.md) - recipes for getting things done,
+    including advanced techniques.
+
+If you need help, please check the
+[KnownIssues](googlemock/docs/KnownIssues.md) and
+[FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before
+posting a question on the
+[discussion group](http://groups.google.com/group/googlemock).
+
 
-Requirements for End Users
---------------------------
+### Using Google Mock Without Google Test ###
 
-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.
+Google Mock is not a testing framework itself.  Instead, it needs a
+testing framework for writing tests.  Google Mock works seamlessly
+with [Google Test](http://code.google.com/p/googletest/), butj
+you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework).
+
+### Requirements for End Users ###
+
+Google Mock is implemented on top of [Google Test](
+http://github.com/google/googletest/), and depends on it.
+You must use the bundled version of Google Test when using Google Mock.
 
 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>
-for how to do it.
+framework, although it will still need Google Test.  Please read
+["Using_Google_Mock_with_Any_Testing_Framework"](
+    docs/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework)
+for instructions.
 
 Google Mock depends on advanced C++ features and thus requires a more
-modern compiler.  The following are needed to use Google Mock:
-
-### Linux Requirements ###
+modern compiler. The following are needed to use Google Mock:
 
-These are the base requirements to build and use Google Mock from a source
-package (as described below):
+#### Linux Requirements ####
 
   * GNU-compatible Make or "gmake"
   * POSIX-standard shell
   * POSIX(-2) Regular Expressions (regex.h)
   * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer)
 
-### Windows Requirements ###
+#### Windows Requirements ####
 
   * Microsoft Visual C++ 8.0 SP1 or newer
 
-### Mac OS X Requirements ###
+#### Mac OS X Requirements ####
 
   * Mac OS X 10.4 Tiger or newer
   * Developer Tools Installed
 
-Requirements for Contributors
------------------------------
+### Requirements for Contributors ###
 
-We welcome patches.  If you plan to contribute a patch, you need to
-build Google Mock and its own tests from an SVN checkout (described
-below), which has further requirements:
+We welcome patches. If you plan to contribute a patch, you need to
+build Google Mock and its tests, which has further requirements:
 
   * Automake version 1.9 or newer
   * Autoconf version 2.59 or newer
@@ -86,62 +123,29 @@ below), which has further requirements:
   * Python version 2.3 or newer (for running some of the tests and
     re-generating certain source files from templates)
 
-Getting the Source
-------------------
-
-There are two primary ways of getting Google Mock's source code: you
-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.
-
-### Git Checkout ###
+### Building Google Mock ###
 
-To check out the master branch of Google Mock, run the following git command:
+#### Preparing to Build (Unix only) ####
 
-    git clone https://github.com/google/googlemock.git
-
-If you are using a \*nix system and plan to use the GNU Autotools build
+If you are using a Unix 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.
+configure it now.
 
-To prepare the Autotools build system, enter the target directory of
-the checkout command you used ('gmock-svn') and proceed with the
-following command:
+To prepare the Autotools build system:
 
+    cd googlemock
     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
-subsequent 'make' invocations will automatically re-generate the bits
-of the build system that need to be changed.
-
-If your system uses older versions of the autotools, the above command
-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
-
-Make sure you're using the same version of automake and aclocal.
-
-Setting up the Build
---------------------
-
 To build Google Mock and your tests that use it, you need to tell your
 build system where to find its headers and source files.  The exact
 way to do it depends on which build system you use, and is usually
 straightforward.
 
-### Generic Build Instructions ###
-
 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
 
@@ -189,7 +193,8 @@ following commands should succeed:
     make
     ./gmock_test
 
-If you see errors, try to tweak the contents of [make/Makefile](make/Makefile) to make them go away.
+If you see errors, try to tweak the contents of
+[make/Makefile](make/Makefile) to make them go away.
 
 ### Windows ###
 
@@ -208,8 +213,7 @@ have to configure it to use the `gmock_config` propety sheet.  For that:
  * In Project Properties | Configuration Properties | General | Additional
    Include Directories, type <path to Google Mock>/include.
 
-Tweaking Google Mock
---------------------
+### Tweaking Google Mock ###
 
 Google Mock can be used in diverse environments.  The default
 configuration may not work (or may not work well) out of the box in
@@ -264,21 +268,20 @@ for instructions on how to set up necessary compiler settings.
 Most of Google Test's control macros apply to Google Mock as well.
 Please see [Google Test's README][gtest_readme] for how to tweak them.
 
-Upgrading from an Earlier Version
----------------------------------
+### Upgrading from an Earlier Version ###
 
 We strive to keep Google Mock releases backward compatible.
 Sometimes, though, we have to make some breaking changes for the
 users' long-term benefits.  This section describes what you'll need to
 do if you are upgrading from an earlier version of Google Mock.
 
-### Upgrading from 1.1.0 or Earlier ###
+#### 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](../googletest/#choosing-a-tr1-tuple-library)".
 
-### Upgrading from 1.4.0 or Earlier ###
+#### 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
@@ -293,21 +296,19 @@ use the new matcher API (
 [polymorphic](http://code.google.com/p/googlemock/wiki/CookBook#Writing_New_Polymorphic_Matchers)).
 Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected.
 
-
-Developing Google Mock
-----------------------
+### Developing Google Mock ###
 
 This section discusses how to make your own changes to Google Mock.
 
-### Testing Google Mock Itself ###
+#### Testing Google Mock Itself ####
 
 To make sure your changes work as intended and don't break existing
 functionality, you'll want to compile and run Google Test's own tests.
 For that you'll need Autotools.  First, make sure you have followed
-the instructions in section "SVN Checkout" to configure Google Mock.
+the instructions above 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  # try --help for more info
 
 Once you have successfully configured Google Mock, the build steps are
 standard for GNU-style OSS packages.
@@ -319,32 +320,14 @@ 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
 separately.
 
-### Regenerating Source Files ###
-
-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.
+#### Contributing a Patch ####
 
-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
-is Useful for Meta Programming) to regenerate them.  You can find
-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.
-
-
-### Contributing a Patch ###
-
-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
+We welcome patches.
+Please read the [Developer's Guide](docs/DevGuide.md)
+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.
 
-
 Happy testing!
 
-[gtest_readme]: ../googletest/ "googletest"
+[gtest_readme]: ../googletest/README.md "googletest"