Skip to content

Commit

Permalink
Attempt to escape less-than and greater-than chars in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alxvasilev committed Jul 9, 2014
1 parent add1e2b commit ec2d496
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ Usage
This is a header-only library. To use, just include the corresponding mingw.xxx.h file, where
xxx would be the name of the standard header that you would normally include.
For additional mutex helper classes, such as std::scoped_guard or std::unique_lock, you need to
include <mutex> before including mingw.mutex.h
include &lt;mutex&gt; before including mingw.mutex.h

Compatibility
=============

This code has been developed with MinGW64 4.8.2, but should work with any other MinGW version
that has C++11 support for lambda functions, variadic templates, and has
working mutex helper classes in <mutex>
working mutex helper classes in &lt;mutex&gt;

Why MinGW has no threading classes
==================================
It seems that for cross-platform threading implementation, the GCC standard library relies on
the gthreads library. If this library is not available, as is the case with MinGW, the
std::thread, std::mutex, std::condition_variable are not defined. However, higher-level mutex
helper classes are still defined in &lt;mutex&gt; and are usable. Hence, this implementation
does not re-define them, and to use these helpers, you should include <mutex> as well, as explained
does not re-define them, and to use these helpers, you should include &lt;mutex&gt; as well, as explained
in the usage section.

0 comments on commit ec2d496

Please sign in to comment.