summaryrefslogtreecommitdiff
path: root/README
blob: b1919680f68b031884006156fb60619f270beaf4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
DISCLAIMER
----------

   THE AUTHORS OF THIS LIBRARY ACCEPT ABSOLUTELY NO LIABILITY FOR
    ANY HARM OR LOSS RESULTING FROM ITS USE.  IT IS _EXTREMELY_ UNWISE
    TO RELY ON SOFTWARE ALONE FOR SAFETY.  Any machinery capable of
    harming persons must have provisions for completely removing power
    from all motors, etc, before persons enter any danger area.  All
    machinery must be designed to comply with local and national safety
    codes, and the authors of this software can not, and do not, take
    any responsibility for such compliance.


The Build Process
-----------------

Refer to the file 'docs/INSTALL' for information about building and 
running the software.
    

Directory Layout
----------------

The directory tree for LinuxCNC is documented in 'directory.map' in the
top level directory.


    COPYING - this software is released under the GPL, 
              with some parts under the LGPL

Please also see the files in docs/

    README  - general information
    INSTALL - information about compiling and installing the software
    AUTHORS - information about authors
    NEWS    - latest news


Quickstart:
-----------

From the top level directory, switch to the source directory:

  cd src

In the source directory, build LinuxCNC:

  ./configure
  [or, if you do not have a realtime kernel:]
  ./configure --enable-simulator

  make clean
  make
  sudo make setuid

to run the software go back to the top level directory, and issue:

  . scripts/rip-environment
  linuxcnc