Browse code

nice up readme

Nat! authored on 26/10/2016 10:58:29
Showing 3 changed files
... ...
@@ -3,9 +3,9 @@
3 3
 Release on [github](//github.com/mulle-nat/mulle-concurrent): [![Build Status](https://travis-ci.org/mulle-nat/mulle-concurrent.svg?branch=release)](https://travis-ci.org/mulle-nat/mulle-concurrent)
4 4
 
5 5
 
6
-**mulle-concurrent** is a library for wait-free data structures. Wait-freeness
7
-is a desirable property for "hotly" contested data structures in multi-threaded
8
-environments.
6
+**mulle-concurrent** is a library for lock- and wait-free data structures.
7
+Wait-freeness is a desirable property for "hotly" contested data structures
8
+in multi-threaded environments.
9 9
 
10 10
 > Many of the ideas are taken from [Preshing on Programming: A Resizable, Concurrent Map](http://preshing.com/20160222/a-resizable-concurrent-map/).
11 11
 > The definition of concurrent and wait-free are from [concurrencyfreaks.blogspot.de](http://concurrencyfreaks.blogspot.de/2013/05/lock-free-and-wait-free-definition-and.html)
... ...
@@ -14,12 +14,11 @@ environments.
14 14
 
15 15
 ## Data structures
16 16
 
17
-Name                            | Description                            | Example
18
-`mulle_concurrent_hashmap`      | A growing, mutable map of pointers, indexed by a hash. A.k.a. hashtable, dictionary, maptable                                          | [Example](tests/hashmap/example.c)
19
-`mulle_concurrent_pointerarray` | A growing array of pointers            | [Example](tests/array/example.c)
20
-
21
-
17
+Name/API                                               | Description    | Example
18
+-------------------------------------------------------|----------------|---------
19
+[`mulle_concurrent_hashmap`](dox/API_POINTERARRAY.md)  | A growing, mutable map of pointers, indexed by a hash. A.k.a. hashtable, dictionary, maptable           | [Example](tests/hashmap/example.c)
20
+[`mulle_concurrent_pointerarray`](dox/API_HASHMAP.md)  | A growing array of pointers
21
+                                                       | [Example](tests/array/example.c)
22 22
 
23 23
 
24 24
 ## Install
... ...
@@ -42,18 +41,11 @@ to install the library:
42 42
 mulle-install --prefix /usr/local --branch release https://www.mulle-kybernetik.com/repositories/mulle-concurrent
43 43
 ```
44 44
 
45
-
46 45
 Otherwise read:
47 46
 
48 47
 * [How to Build](dox/BUILD.md)
49 48
 
50 49
 
51
-## API
52
-
53
-* [mulle_concurrent_pointerarray](dox/API_POINTERARRAY.md)
54
-* [mulle_concurrent_hashmap](dox/API_HASHMAP.md)
55
-
56
-
57 50
 ### Platforms and Compilers
58 51
 
59 52
 All platforms and compilers supported by
... ...
@@ -1,4 +1,4 @@
1
-1.0.1-1.0.5
1
+1.0.1-1.0.6
2 2
 ===
3 3
 
4 4
 * fix packaging
... ...
@@ -35,7 +35,7 @@
35 35
 #define mulle_concurrent_h__
36 36
 
37 37
 
38
-#define MULLE_CONCURRENT_VERSION  ((1 << 20) | (0 << 8) | 5)
38
+#define MULLE_CONCURRENT_VERSION  ((1 << 20) | (0 << 8) | 6)
39 39
 
40 40
 #include <mulle_thread/mulle_thread.h>
41 41
 #include <mulle_allocator/mulle_allocator.h>