improving docs

CONTRIBUTING.md

@@ -18,3 +18,56 @@ Your pull request should:
 	* limit using clang format on new code
 	* do not deviate from style already established in the files
 
+
+### Running the Unit Tests
+
+EAAssert uses CMake as its build system.
+
+* Create and navigate to "your_build_folder":
+	* mkdir your_build_folder && cd your_build_folder
+* Generate build scripts:
+	* cmake eastl_source_folder -DEABASE_BUILD_TESTS:BOOL=ON
+* Build unit tests for "your_config":
+	* cmake --build . --config your_config
+* Run the unit tests for "your_config" from the test folder:
+	* cd test && ctest -C your_config
+
+
+Here is an example batch file.
+```batch
+set build_folder=out
+mkdir %build_folder%
+pushd %build_folder%
+call cmake .. -DEABASE_BUILD_TESTS:BOOL=ON
+call cmake --build . --config Release
+call cmake --build . --config Debug
+call cmake --build . --config RelWithDebInfo
+call cmake --build . --config MinSizeRel
+pushd test
+call ctest -C Release
+call ctest -C Debug
+call ctest -C RelWithDebInfo
+call ctest -C MinSizeRel
+popd
+popd
+```
+
+Here is an example bash file
+```bash
+build_folder=out
+mkdir $build_folder
+pushd $build_folder
+cmake .. -DEABASE_BUILD_TESTS:BOOL=ON
+cmake --build . --config Release
+cmake --build . --config Debug
+cmake --build . --config RelWithDebInfo
+cmake --build . --config MinSizeRel
+pushd test
+ctest -C Release
+ctest -C Debug
+ctest -C RelWithDebInfo
+ctest -C MinSizeRel
+popd
+popd
+```
+

README.md

@@ -1,4 +1,26 @@
 # EABase
-EABase is a small set of header files that define platform-independent data types and macros.
 
 [![Build Status](https://travis-ci.org/electronicarts/EABase.svg?branch=master)](https://travis-ci.org/electronicarts/EABase)
+
+EABase is a small set of header files that define platform-independent data types and macros.
+
+
+## Documentation
+
+Please see [Introduction](https://rawgit.com/electronicarts/EABase/master/doc/EABase.html).
+
+
+## Compiling sources
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on compiling and testing the source.
+
+
+## Credits
+
+Roberto Parolin is the current EABase owner within EA and is responsible for the open source repository.
+
+
+## License
+
+Modified BSD License (3-Clause BSD license) see the file LICENSE in the project root.
+