Adding README file
[tinymsg.git] / README.md
1 tinymsg
2 =======
3
4 Tiny messages system for communicating threads each other.
5
6 Usage
7 -----
8
9 ```
10 scheme@(guile-user)> (use-modules (tinymsg))
11 scheme@(guile-user)> (send-message 'msgbox "Hello World!!")
12 $1 = "Hello World!!"
13 scheme@(guile-user)> (receive-message 'msgbox)
14 $2 = "Hello World!!"
15 scheme@(guile-user)> (map
16                        (lambda (n)
17                          (send-message 'msgbox n))
18                        '(1 2 3 4 5))
19 $3 = (1 2 3 4 5)
20 scheme@(guile-user)> (flush-messages 'msgbox)
21 msgbox got 1
22 msgbox got 2
23 msgbox got 3
24 msgbox got 4
25 msgbox got 5
26 ```
27
28 Requirements
29 ------------
30
31 * GNU Guile >= 2.0.11
32
33 License
34 -------
35
36 GNU GPLv3+