Added README file and altered outputs of install.sh
authorFlorian Pose <fp@igh-essen.com>
Fri, 07 Apr 2006 14:19:20 +0000
changeset 171 faa7d433239c
parent 170 357dd6f677fd
child 172 e84c21548a8d
Added README file and altered outputs of install.sh
README
install.sh
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Apr 07 14:19:20 2006 +0000
@@ -0,0 +1,50 @@
+-------------------------------------------------------------------------------
+
+$Id$
+
+-------------------------------------------------------------------------------
+
+General Information
+===================
+
+This is an Open-Source EtherCAT master implementation for Linux 2.6.
+
+For more information, see
+
+http://etherlab.org
+
+or contact
+
+Florian Pose <fp@igh-essen.com>
+Ingenieurgemeinschaft IgH
+Heinz-Baecker-Str. 34
+D-45356 Essen
+http://igh-essen.com
+
+-------------------------------------------------------------------------------
+
+Installation
+============
+
+1) Create a copy of the configuration template:
+
+  $ cp ethercat.conf.tmpl ethercat.conf
+
+2) Adjust the Variables in the configuration file to your needs.
+
+3) Build the EtherCAT master and network device driver modules:
+
+  $ make
+
+4) Install the the EtherCAT master (as root):
+
+  # make install
+
+  This will create the following files and directories:
+    - /etc/sysconfig/ethercat (configuration file)
+    - /etc/init.d/ethercat    (startup script)
+    - /usr/sbin/rcethercat    (link to startup script)
+
+  The modules will be placed in /lib/modules/`uname -r`/kernel/drivers/net.
+
+-------------------------------------------------------------------------------
--- a/install.sh	Fri Apr 07 14:16:12 2006 +0000
+++ b/install.sh	Fri Apr 07 14:19:20 2006 +0000
@@ -25,7 +25,7 @@
 # Fetch parameter
 
 if [ $# -ne 2 ]; then
-    echo "Usage: $0 <KERNEL> <DEVICEINDEX>"
+    echo "This script is called by \"make\". Run \"make install\" instead."
     exit 1
 fi