diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e21e48a..ff7d5c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ You can sign here: [Go to CLA](https://electronicarts.na1.echosign.com/public/es ### Pull Request Policy -All code contributions to EASTL are submitted as [Github pull requests](https://help.github.com/articles/using-pull-requests/). All pull requests will be reviewed by an EASTL maintainer according to the guidelines found in the next section. +All code contributions are submitted as [Github pull requests](https://help.github.com/articles/using-pull-requests/). All pull requests will be reviewed by a maintainer according to the guidelines found in the next section. Your pull request should: @@ -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 source_folder -DEASTDC_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 .. -DEASTDC_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 .. -DEASTDC_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 +``` + diff --git a/README.md b/README.md index 83019fa..1648f3a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ # EAStdC -EAStdC is a package which implements a number of basic library facilities that are similar to those in the standard C library. [![Build Status](https://travis-ci.org/electronicarts/EAStdC.svg?branch=master)](https://travis-ci.org/electronicarts/EAStdC) + +EAStdC is a package which implements a number of basic library facilities that are similar to those in the standard C library. + + +## Documentation + +Please see [Introduction](doc/EAStdC.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. +