1
- ************
2
- * OVERVIEW *
3
- ************
4
-
1
+ OVERVIEW
2
+ ========
5
3
Ach is an Inter-Process Communication (IPC) mechanism and library. It
6
4
is especially suited for communication in real-time systems that
7
5
sample data from physical processes. Ach eliminates the Head-of-Line
@@ -11,45 +9,37 @@ has been tested and demonstrated on a variety of physical robotic
11
9
systems. Source code for Ach is available under an Open Source
12
10
BSD-style license.
13
11
14
- ****************
15
- * INSTALLATION *
16
- ****************
17
-
18
- `./configure && make && make install'
12
+ INSTALLATION
13
+ ============
14
+ ./configure && make && make install
19
15
20
16
See the INSTALL file for details.
21
17
22
- *********************
23
- * Example and Usage *
24
- *********************
25
-
26
- - Example Code: ./src/ach-example.c
27
- - Shell Tool `ach': can be used to create channels:
28
- - Create a channel `ach -C CHANNEL_NAME'
29
- - Delete a channel `ach -U CHANNEL_NAME'
30
- - Display channel stats `ach -D CHANNEL_NAME'
31
- - View options `ach -H'
32
-
33
- ****************
34
- * Formal Model *
35
- ****************
36
-
18
+ Example and Usage
19
+ =================
20
+ * Example Code: `./src/ach-example.c`
21
+ * Shell Tool `ach`: can be used to create channels:
22
+ * Create a channel `ach -C CHANNEL_NAME`
23
+ * Delete a channel `ach -U CHANNEL_NAME`
24
+ * Display channel stats `ach -D CHANNEL_NAME`
25
+ * View options `ach -H`
26
+
27
+ Formal Model
28
+ ============
37
29
Ach has been formally verified using the SPIN model checker. This
38
- formal model is included in the sourc distribution under the ./spin/
30
+ formal model is included in the source distribution under the ` ./spin/`
39
31
directory.
40
32
41
- **************************
42
- * Performance/Benchmarks *
43
- **************************
44
-
33
+ Performance/Benchmarks
34
+ ======================
45
35
To evaluate the performance of ach on your machine, you can use the
46
- included `ach-bench' program to test messaging latency. See the shell
47
- script `src/run-benchmarks' which runs the benchmark with a variety of
36
+ included `ach-bench` program to test messaging latency. See the shell
37
+ script `src/run-benchmarks` which runs the benchmark with a variety of
48
38
options.
49
39
50
- *******************
51
- * Further Details *
52
- *******************
53
-
40
+ Further Details
41
+ ===============
54
42
A technical report describing design and rationale behind Ach is available at:
55
43
http://www.golems.org/node/1526
44
+
45
+ API documentation is available at http://golems.github.com/ach/.
0 commit comments