Skip to content

Update README.md to include all latest features #124

@cs-util

Description

@cs-util

Improve the https://github.com/cs-util-com/cscore/blob/master/README.md to include more of the features of cscore. The readme was not updated regularly with all the new features, only the unit tests that serve also as usage examples are still up to date, so reviewing all tests and adding the relevant/interesting features that are still missing in the readme would be a good idea to give the reader a quick and easy overview on what is available.

Here are all usage examples how to use the pure C# components (that can be used in any C# project and in Unity):
https://github.com/cs-util-com/cscore/tree/master/CsCore/xUnitTests/src/Plugins/CsCoreXUnitTests/com/csutil/tests

And here are Unity specific examples / demo scenes on the components that can be used only in Unity:
https://github.com/cs-util-com/cscore/tree/master/CsCore/UnityTests/Assets/Plugins/CsCoreUnityDemoScenes

Also include the info that the xunit tests are now split in a "tests" namespace and an "integrationTests" namespace:

  • tests - These are xunit tests that can be run all in parallel and must never fail. They can also be used in mutation testing via Stryker
  • integrationTests - These are tests that use some global state or APIs and can fail from time to time because of these external dependencies the test cant control. Because of this they are also not suited to be used in mutation testing

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions