Skip to content

Commit

Permalink
update: readme, submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
luncliff committed Mar 1, 2019
1 parent be75a5d commit 3f804ca
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
20 changes: 17 additions & 3 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,13 @@ Utility types are in the following headers
#include <coroutine/sync.h> // synchronization utilities
```

Network Asnyc I/O and some helper functions are placed in
Go language style channel to deliver data between coroutines

```c++
#include <coroutine/channel.hpp> // channel<T, Lockable>
```

Network Asnyc I/O and some helper functions are placed in one header.

```c++
#include <coroutine/net.h> // shows asnyc i/o
Expand All @@ -56,7 +62,7 @@ Please reference [`.travis.yml`](./.travis.yml) and [`appveyor.yml`](./appveyor.
#### Tool Support

* Visual Studio 2017 or later
* `msvc`
* `msvc` (vc141)
* CMake
* `msvc`
* `clang-cl`: Windows with VC++ headers. **Requires static linking**
Expand All @@ -83,7 +89,6 @@ I recommend you to import(add reference) [win32.vcxproj](./modules/win32.vcxproj

#### CMake Project

Currently version doesn't export build results for CMake's `find_package`.
Expect there is a higher CMake project which uses this library.

```cmake
Expand All @@ -99,6 +104,15 @@ PUBLIC
)
```

#### Package Manager

Following package managers and build options are available.

* [vcpkg](https://github.com/Microsoft/vcpkg/tree/master/ports/coroutine)
* x64-windows
* x64-linux
* x64-osx

## License

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
2 changes: 1 addition & 1 deletion external/catch2
Submodule catch2 updated 71 files
+2 −2 .conan/build.py
+29 −0 .github/ISSUE_TEMPLATE/bug_report.md
+14 −0 .github/ISSUE_TEMPLATE/feature_request.md
+0 −29 .github/issue_template.md
+2 −3 .travis.yml
+1 −1 CMakeLists.txt
+2 −2 README.md
+11 −4 contrib/ParseAndAddCatchTests.cmake
+2 −0 docs/commercial-users.md
+6 −5 docs/configuration.md
+39 −17 docs/contributing.md
+5 −0 docs/deprecations.md
+104 −29 docs/generators.md
+3 −0 docs/list-of-examples.md
+3 −0 docs/logging.md
+3 −0 docs/opensource-users.md
+59 −0 docs/release-notes.md
+22 −0 docs/release-process.md
+43 −3 docs/test-cases-and-sections.md
+31 −7 docs/test-fixtures.md
+3 −2 docs/tutorial.md
+3 −3 examples/210-Evt-EventListeners.cpp
+59 −0 examples/300-Gen-OwnGenerator.cpp
+72 −0 examples/310-Gen-VariablesInGenerators.cpp
+2 −0 examples/CMakeLists.txt
+20 −4 include/catch.hpp
+4 −4 include/internal/catch_common.h
+15 −1 include/internal/catch_compiler_capabilities.h
+2 −1 include/internal/catch_console_colour.cpp
+2 −5 include/internal/catch_debugger.h
+73 −1 include/internal/catch_decomposer.h
+12 −6 include/internal/catch_exception_translator_registry.cpp
+5 −23 include/internal/catch_generators.cpp
+264 −140 include/internal/catch_generators.hpp
+9 −9 include/internal/catch_interfaces_generatortracker.h
+0 −3 include/internal/catch_interfaces_testcase.h
+10 −8 include/internal/catch_list.cpp
+1 −1 include/internal/catch_list.h
+81 −0 include/internal/catch_meta.hpp
+5 −0 include/internal/catch_preprocessor.hpp
+6 −14 include/internal/catch_run_context.cpp
+1 −1 include/internal/catch_run_context.h
+14 −6 include/internal/catch_session.cpp
+0 −2 include/internal/catch_stringref.h
+5 −4 include/internal/catch_suppress_warnings.h
+12 −45 include/internal/catch_test_case_tracker.cpp
+4 −19 include/internal/catch_test_case_tracker.h
+68 −0 include/internal/catch_test_registry.h
+1 −1 include/internal/catch_timer.cpp
+19 −0 include/internal/catch_tostring.h
+2 −0 include/internal/catch_type_traits.hpp
+1 −1 include/internal/catch_version.cpp
+2 −0 include/internal/catch_xmlwriter.cpp
+7 −0 include/reporters/catch_reporter_junit.cpp
+1 −1 include/reporters/catch_reporter_tap.hpp
+36 −3 misc/coverage-helper.cpp
+8 −0 projects/CMakeLists.txt
+193 −206 projects/SelfTest/Baselines/compact.sw.approved.txt
+46 −2 projects/SelfTest/Baselines/console.std.approved.txt
+3,000 −3,317 projects/SelfTest/Baselines/console.sw.approved.txt
+56 −19 projects/SelfTest/Baselines/junit.sw.approved.txt
+1,690 −1,638 projects/SelfTest/Baselines/xml.sw.approved.txt
+89 −79 projects/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp
+23 −143 projects/SelfTest/IntrospectiveTests/PartTracker.tests.cpp
+22 −0 projects/SelfTest/UsageTests/Class.tests.cpp
+82 −69 projects/SelfTest/UsageTests/Generators.tests.cpp
+14 −0 projects/SelfTest/UsageTests/Misc.tests.cpp
+23 −0 projects/SelfTest/UsageTests/ToStringOptional.tests.cpp
+22 −15 projects/SelfTest/UsageTests/ToStringVariant.tests.cpp
+634 −299 single_include/catch2/catch.hpp
+1 −1 single_include/catch2/catch_reporter_tap.hpp
2 changes: 1 addition & 1 deletion external/guideline
Submodule guideline updated 2 files
+22 −0 .travis.yml
+5 −1 README.md

0 comments on commit 3f804ca

Please sign in to comment.