doc: add missing -lm option to command line for compiling tut1
[comedilib.git] / README
1
2     COMEDILIB
3     The Linux Control and Measurement Device Interface Library
4     David Schleef <ds@schleef.org>
5
6
7 * About Comedi:
8
9 Comedi is a collection of drivers for data acquisition hardware.
10 These drivers work with Linux, and also with Linux combined with
11 the real-time extensions RTAI and RTLinux.  The Comedi core, which
12 ties all the driver together, allows applications to be written
13 that are completely hardware independent.
14
15 Comedi supports a variety of data acquisition hardware; an
16 incomplete list can be found in the Comedi source.
17
18 This distribution contains only the user-space library.  You will
19 almost certainly also want to download the Comedi kernel modules
20 found in the "comedi" tarball.  Also, the calibration programs
21 comedi_calibrate and comedi_soft_calibrate can be found in the
22 "comedi_calibrate" tarball.  A few boards also need firmware
23 found in the "comedi-nonfree-firmware" tarball.
24
25 * Installation:
26
27 Installation instructions are found in INSTALL.
28
29 * Mailing List:
30
31 Questions about Comedi and Comedilib should be sent to the Comedi
32 mailing list, <comedi_list@googlegroups.com>.  It is necessary to
33 join the group before posting (see below).  It is also possible to
34 post to the list using the web interface (see below).  Mailing the
35 maintainer directly is always acceptable, but since the mailing list
36 is archived and questions are often answered more quickly by others,
37 the mailing list is preferred.
38
39 To subscribe to and unsubscribe from the mailing list, or to read or
40 post messages via the web interface, go to
41 <http://groups.google.com/group/comedi_list>.  Alternatively, you
42 can send a blank email to <comedi_list+subscribe@googlegroups.com>
43 to subscribe, or to <comedi_list+unsubscribe@googlegroups.com> to
44 unsubscribe (making sure the "From:" email address matches the
45 address you originally subscribed with!).
46
47 Traffic on the list is light, and mainly questions/answers about
48 comedi installation, bugs, and programming.  General questions
49 about data acquisition are also welcome.
50
51 * More Information:
52
53 Comedi also has a web page at <http://www.comedi.org/> from where
54 updated versions may be downloaded.
55
56 Often bugfixes and new features that are not in the current release
57 can be found in the Git repository.  Instructions for access to the
58 Comedi and Comedilib repositories can be found at
59 <http://www.comedi.org/download.html>.  Git snapshots for Comedilib
60 can be created automatically at
61 <http://comedi.org/git?p=comedi/comedilib.git;a=tree>.  The Git
62 repository can be cloned locally using:
63
64   git clone git://comedi.org/git/comedilib.git
65
66 Comedilib may be freely distibuted and modified in accordance with
67 the GNU Lesser General Public License.  Portions of the Comedilib
68 distribution fall under different licenses; see the individual files
69 for details.
70
71 The person behind all this misspelled humor is David Schleef
72 <ds@schleef.org>.
73