diff -r c4afc5fede19 -r af3eda069078 README --- a/README Mon Oct 24 10:49:27 2011 +0200 +++ b/README Fri Oct 28 11:31:54 2011 +0200 @@ -1,4 +1,4 @@ -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ This is the README file of the IgH EtherCAT Master. @@ -6,7 +6,7 @@ vim: spelllang=en spell tw=78 -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ Contents: 1) General Information @@ -14,8 +14,9 @@ 3) Building and installing 4) Realtime & Tuning 5) License +6) Coding Style -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ 1) General Information ====================== @@ -33,7 +34,7 @@ D-45356 Essen http://igh-essen.com -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ 2) Requirements =============== @@ -48,27 +49,27 @@ A table of supported hardware can be found at http://etherlab.org/en/ethercat/hardware.php. -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ 3) Building and installing ========================== See the INSTALL file. -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ 4) Realtime & Tuning ==================== Realtime patches for the Linux kernel are supported, but not required. The realtime processing has to be done by the calling module (see API -documentation). The EtherCAT master code itself is passive (except for the idle -mode and EoE). +documentation). The EtherCAT master code itself is passive (except for the +idle mode and EoE). To avoid frame timeouts, deactivating DMA access for hard drives is recommended (hdparm -d0 ). -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ 5) License ========== @@ -96,4 +97,11 @@ technology and brand is only permitted in compliance with the industrial property and similar rights of Beckhoff Automation GmbH. -------------------------------------------------------------------------------- +------------------------------------------------------------------------------ + +6) Coding Style +=============== + +Developers shall use the coding style rules in the CodingStyle.txt file. + +------------------------------------------------------------------------------