Commit aa5a32b
committed
Updated readme.
1 parent 1f24f0f commit aa5a32b
1 file changed
Lines changed: 13 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,42 +6,41 @@ Generally speaking, it provides abstractions to handle change propagation and da | |||
| 6 | 6 | A more practical description is that it enables coordinated, multi-layered - and potentially parallel - execution of callbacks. | |
| 7 | 7 | All this happens implicitly, based on declarative definitions, with guarantees regarding | |
| 8 | 8 | ||
| 9 | - - update-minimality - nothing is re-calculated or processed unnecessarily; | ||
| 10 | - - glitch-freedom - no transiently inconsistent data sets; | ||
| 11 | - - thread-safety - no data races for parallel execution. | ||
| 9 | + - _update minimality_ - nothing is re-calculated or processed unnecessarily; | ||
| 10 | + - _glitch freedom_ - no transiently inconsistent data sets; | ||
| 11 | + - _thread safety_ - no data races for parallel execution. | ||
| 12 | 12 | ||
| 13 | 13 | The core abstractions of the library are | |
| 14 | 14 | ||
| 15 | - - **signals**, reactive variables that are automatically re-calculated when their dependencies change, and | ||
| 16 | - - **event streams** as composable first class objects. | ||
| 15 | + - _signals_, reactive variables that are automatically re-calculated when their dependencies change, and | ||
| 16 | + - _event streams_ as composable first class objects. | ||
| 17 | 17 | ||
| 18 | 18 | Signals specifically deal with aspects of time-varying state, whereas event streams facilitate event processing in general. | |
| 19 | 19 | ||
| 20 | 20 | Additional features include | |
| 21 | 21 | ||
| 22 | - - a publish/subscribe mechanism for callbacks with side-effects; | ||
| 22 | + - a publish/subscribe mechanism for callbacks with side effects; | ||
| 23 | 23 | - a set of operations and algorithms to combine signals and events; | |
| 24 | 24 | - a domain model to encapsulate multiple reactive systems; | |
| 25 | 25 | - transactions to group related events, supporting both synchronous and asynchrounous execution. | |
| 26 | 26 | ||
| 27 | 27 | ||
| 28 | 28 | ## Documentation | |
| 29 | 29 | ||
| 30 | - If you're interested in learning about C++React, [have a look at its documentation](http://schlangster.github.io/cpp.react/). | ||
| 31 | - | ||
| 32 | - It's still incomplete, but it already contains plenty of useful information and examples. | ||
| 30 | + [If you're interested in learning about C++React, have a look at its documentation.](http://schlangster.github.io/cpp.react/) | ||
| 33 | 31 | ||
| 34 | 32 | ||
| 35 | 33 | ## Development | |
| 36 | 34 | ||
| 37 | 35 | This library is a work-in-progress and should not be considered release quality yet. | |
| 38 | - Don't let this statement stop you from giving it a try though. | ||
| 39 | - It's in a usable state and has already received a fair amount of testing and tuning. | ||
| 36 | + It is, however, in a perfectly usable state and has already received a fair amount of testing and tuning. | ||
| 40 | 37 | ||
| 41 | 38 | ||
| 42 | 39 | ### Compiling | |
| 43 | 40 | ||
| 44 | - The following compilers are supported at the moment: | ||
| 41 | + C++React requires a compiler with support for several C++11 features. | ||
| 42 | + | ||
| 43 | + It has been tested with the following compilers: | ||
| 45 | 44 | ||
| 46 | 45 | * Visual Studio 2013.2 | |
| 47 | 46 | * GCC 4.8.2 | |
@@ -57,7 +56,7 @@ cmake .. | |||
| 57 | 56 | make | |
| 58 | 57 | ``` | |
| 59 | 58 | ||
| 60 | - For more details, see [Build instructions](https://github.com/schlangster/cpp.react/wiki/Build-instructions). | ||
| 59 | + For more details, refer to the [Build instructions](https://github.com/schlangster/cpp.react/wiki/Build-instructions). | ||
| 61 | 60 | ||
| 62 | 61 | ||
| 63 | 62 | ### Dependencies | |
@@ -72,7 +71,7 @@ For more details, see [Build instructions](https://github.com/schlangster/cpp.re | |||
| 72 | 71 | ### Signals | |
| 73 | 72 | ||
| 74 | 73 | Signals are self-updating reactive variables. | |
| 75 | - They can be combined to expressions to create new signals, which are automatically re-calculated whenever one of their data dependencies changes. | ||
| 74 | + They can be combined as expressions to create new signals, which are automatically re-calculated whenever one of their dependencies changes. | ||
| 76 | 75 | ||
| 77 | 76 | ```C++ | |
| 78 | 77 | using namespace std; | |
0 commit comments