/ README
README
 1  README file for AXIS, a front-end for EMC 
 2  Copyright (C) 2004, 2005, 2006 Jeff Epler <jepler@unpythonic.net> and
 3      Chris Radek <chris@timeguy.com>
 4  
 5  
 6  
 7  ABOUT AXIS
 8  ==========
 9  
10  AXIS is a front-end for EMC with file preview and live plot.
11  
12  The AXIS user interface is intended to be self-documenting by use of
13  familiar controls and plain language on tooltips and menus.  A few less
14  evident features are documented by Help > Quick Reference.
15  
16  Python 2.4 or newer with Tkinter is required.  Hardware accelerated
17  OpenGL is nice, but not required.
18  
19  AXIS is compatible with emc1 and emc2.
20  
21  AXIS's home page is http://axis.unpythonic.net/
22  
23  
24  INSTALLATION
25  ============
26  
27  In the AXIS source directory, run the installer as root:
28      $ env EMCROOT=/xxx python setup.py install
29  
30  For EMC1, EMCROOT is the absolute path to the directory where the "emc" and
31  "rcslib" directories reside.  For EMC1, you may also be required to give
32  the value for PLAT, the non-realtime platform that EMC is configured to
33  use.  In this case, the commandline would look like
34      $ env EMCROOT=/xxx PLAT=yyy python setup.py install
35  
36  For EMC2, EMCROOT is the absolute path to the "emc" directory.
37  It is not necessary to specify PLAT for EMC2.
38  
39  To make EMC actually use AXIS as the front-end, find the "DISPLAY" line
40  in your ini file.  Change it to read "DISPLAY = axis".
41  
42  
43  LICENSE
44  =======
45  
46  This program is free software; you can redistribute it and/or modify
47  it under the terms of the GNU General Public License as published by
48  the Free Software Foundation; either version 2 of the License, or
49  (at your option) any later version.
50  
51  This program is distributed in the hope that it will be useful,
52  but WITHOUT ANY WARRANTY; without even the implied warranty of
53  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
54  GNU General Public License for more details.
55  
56  You should have received a copy of the GNU General Public License
57  along with this program; if not, write to the Free Software
58  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
59  
60  
61  Portions of the program, located in the "thirdparty" subdirectory of the
62  source distribution, are covered by other licenses.  Please see those
63  files for details.