Recent changes to Installation

Installation modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:59:19 -0000

--- v6
+++ v7
@@ -1 +1,3 @@
 [[include repo=code path=doc/wiki/installation.md]]
+## Download ##
+[[download_button]]

Installation modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:58:30 -0000

--- v5
+++ v6
@@ -1,142 +1 @@
-# Installation #
-
-Table of contents:
-
-[TOC]
-
-## Overview ##
-
-comFramework is distributed as a ZIP archive. The initial installation
-step is unzipping the contents to a directory of your choice. The
-directory should grant read and write access to all users.
-
-The downloaded comFramework archive contains source files for integration
-in target projects, the Java applications, that implement the two code
-generators, which support the interface design, and two sample
-integrations.
-
-The source files for integration don't need any installation (with the
-trivial exception of a text editor to open and read them).
-
-The DBC code generator is always needed. Its installation means to set an
-environment variable and optionally to extend the system's search path.
-
-excelExporter, the auxiliary code generator is not essential but useful.
-Its installation means to set an environment variable and optionally to
-extend the system's search path.
-
-The sample integrations come along with the generated C source code. They
-are mainly meant as instructive sample code. An installation of tools is
-not required if this suffices, if there's no need or intention to alter
-the sample code and re-compile it.
-
-The Arduino sample comes along with source code and the compiled
-executable; you can immediately upload it to your Arduino Mega 2560 board
-and see how it behaves.
-
-If the Windows example should be needed as a running application for
-further investigation or debugging then GCC needs to be installed. 32 and
-64 Bit versions are supported but only a few versions of GCC have been
-tested.
-
-Compilation of the Windows sample has been done under Windows 7 only. The
-code is free of specific operation system calls and only uses functions
-from the GCC libraries. As these are widely operation system independent
-the sample should compile and run under other Windows versions, Linux and
-Mac OS as well; this has however never been tested and as a matter of
-experience most often there are some minor incompatibilities, which have
-to be sorted out first - just give it a try. Feedback is welcome.
-
-Using another compiler than GCC will mean code changes in the application
-interface, command line evaluation in the first place.
-
-All C compilation and related operations is controlled from makefiles,
-which need GNU make 3.81. If you type "make --version" in a shell window
-this revision of make needs to respond. Other make derivates or elder
-revisions of GNU make won't work.
-
-
-## Code generator ##
-
-The installation of the main code generator is described in detail in file
-[installation.txt](http://svn.code.sf.net/p/comframe/code/codeGenerator/trunk/doc/installation.txt
-"SVN"); the file can be found locally as
-comFramework/codeGenerator/doc/installation.txt.
-
-Please refer to the files readMe.txt in any of the root directories of the
-samples, which come along with the code generator for more details on how
-to run the code generator.
-
-## excelExporter ##
-
-The installation of the auxiliary code generator excelExporter is
-described in detail in file [installation.txt](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/installation.txt
-"SVN"); the file can be found locally as
-comFramework/excelExporter/doc/installation.txt.
-
-Please refer to the files readMe.txt in any of the root directories of the
-samples, which come along with excelExporter for more details on how to
-run excelExporter.
-
-## Arduino sample integration ##
-
-Arduino 1.0.6 needs to be installed for compilation of the sample and even
-for upload of the pre-compiled binary. (The GCC avr tools are taken from the
-Arduino installation.) Please refer to <http: www.arduino.cc=""/>.
-
-Caution: Do not install the more recent revision Arduino 1.6.5: This
-package no longer contains all required GCC avr tools.
-
-A new environment variable needs to be set. Let ARDUINO_HOME point to
-the root directory of the Arduino 1.0.6 installation. All tools are located
-via this variable.
-
-Modify the system path variable, so that GNU make 3.81 is found when
-typing make. Having Arduino 1.0.6 installed this will mean to add
-.../arduino-1.0.6/hardware/tools/avr/utils/bin to environment variable
-PATH.
-
-In a shell window type
-
-make --version
-
-GNU make 3.81 should respond. Now CD to the root directory
-comFramework/canInterface/components/arduinoSampleIntegration of the
-Arduino sample and type
-
-make -s clean  
-make -s build
-
-to rebuild the sample (which includes the generation of the network database
-dependent C code of the CAN interface). Try "make help", too.
-
-Please refer to file readMe.md in the root of the Arduino sample for
-further details.
-
-## Windows sample integration ##
-
-GNU make 3.81 needs to be installed. GCC (32 or 64 Bit) needs to be
-installed. Under Windows, only use MinGW distributions. The Cygwin
-distributions will probably need some modifications of the makefiles.
-
-On principle, the makefiles are prepared to support the compilation under
-Linux and Mac OS as well. If problems appear you should first have a look
-into sub-makefile locateTools.mk, which is responsible to find the paths
-to the executables. There are different configuration possibilities to
-find the tools either via system search path or via environment variable
-settings. Maybe you need to alter this configuration first. The same holds
-if you have different GCC revisions installed and want to switch between
-them.
-
-If GNU make 3.81 and GCC are installed then you can CD to the root
-directory comFramework/canInterface/components/winSampleIntegration of the
-Windows sample integration and type
-
-make -s clean  
-make -s build
-
-to rebuild the sample (which includes the generation of the network database
-dependent C code of the CAN interface). Try make help, too.
-
-Please refer to file readMe.md in the root of the Windows sample for
-further details.
+[[include repo=code path=doc/wiki/installation.md]]

Installation modified by Peter Vranken

Peter Vranken — Thu, 17 Mar 2016 21:55:28 -0000

--- v4
+++ v5
@@ -71,8 +71,8 @@

 The installation of the auxiliary code generator excelExporter is
 described in detail in file [installation.txt](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/installation.txt
-"SVN"); the file
-can be found locally as comFramework/excelExporter/doc/installation.txt.
+"SVN"); the file can be found locally as
+comFramework/excelExporter/doc/installation.txt.

 Please refer to the files readMe.txt in any of the root directories of the
 samples, which come along with excelExporter for more details on how to
@@ -80,20 +80,20 @@

 ## Arduino sample integration ##

-Arduino 1.0.5 needs to be installed for compilation of the sample and even
+Arduino 1.0.6 needs to be installed for compilation of the sample and even
 for upload of the pre-compiled binary. (The GCC avr tools are taken from the
 Arduino installation.) Please refer to <http: www.arduino.cc=""/>.

 Caution: Do not install the more recent revision Arduino 1.6.5: This
 package no longer contains all required GCC avr tools.

-A new environment variable needs to be set. Let ARDUINO_HOME point to the
-root directory of the Arduino 1.0.5 installation. All tools are located
+A new environment variable needs to be set. Let ARDUINO_HOME point to
+the root directory of the Arduino 1.0.6 installation. All tools are located
 via this variable.

 Modify the system path variable, so that GNU make 3.81 is found when
-typing make. Having Arduino 1.0.5 installed this will mean to add
-.../arduino-1.0.5/hardware/tools/avr/utils/bin to environment variable
+typing make. Having Arduino 1.0.6 installed this will mean to add
+.../arduino-1.0.6/hardware/tools/avr/utils/bin to environment variable
 PATH.

 In a shell window type

Installation modified by Peter Vranken

Peter Vranken — Thu, 17 Mar 2016 21:52:59 -0000

--- v3
+++ v4
@@ -11,23 +11,28 @@
 directory should grant read and write access to all users.

 The downloaded comFramework archive contains source files for integration
-in target projects, the Java application, that implements the code
-generator, which supports the interface design, and two sample
+in target projects, the Java applications, that implement the two code
+generators, which support the interface design, and two sample
 integrations.

 The source files for integration don't need any installation (with the
 trivial exception of a text editor to open and read them).

-The code generator is always needed. It's installation means to set an
+The DBC code generator is always needed. Its installation means to set an
 environment variable and optionally to extend the system's search path.
+
+excelExporter, the auxiliary code generator is not essential but useful.
+Its installation means to set an environment variable and optionally to
+extend the system's search path.

 The sample integrations come along with the generated C source code. They
 are mainly meant as instructive sample code. An installation of tools is
 not required if this suffices, if there's no need or intention to alter
 the sample code and re-compile it.

-The Arduino sample comes along even with the compiled executable, you can
-directly upload it to your Arduino Mega 2560 board and see how it behaves.
+The Arduino sample comes along with source code and the compiled
+executable; you can immediately upload it to your Arduino Mega 2560 board
+and see how it behaves.

 If the Windows example should be needed as a running application for
 further investigation or debugging then GCC needs to be installed. 32 and
@@ -46,14 +51,14 @@
 interface, command line evaluation in the first place.

 All C compilation and related operations is controlled from makefiles,
-which need GNU make 3.81. If you type make --version in a shell window
+which need GNU make 3.81. If you type "make --version" in a shell window
 this revision of make needs to respond. Other make derivates or elder
 revisions of GNU make won't work.

 ## Code generator ##

-The installation of the code generator is described in detail in file
+The installation of the main code generator is described in detail in file
 [installation.txt](http://svn.code.sf.net/p/comframe/code/codeGenerator/trunk/doc/installation.txt
 "SVN"); the file can be found locally as
 comFramework/codeGenerator/doc/installation.txt.
@@ -61,6 +66,17 @@
 Please refer to the files readMe.txt in any of the root directories of the
 samples, which come along with the code generator for more details on how
 to run the code generator.
+
+## excelExporter ##
+
+The installation of the auxiliary code generator excelExporter is
+described in detail in file [installation.txt](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/installation.txt
+"SVN"); the file
+can be found locally as comFramework/excelExporter/doc/installation.txt.
+
+Please refer to the files readMe.txt in any of the root directories of the
+samples, which come along with excelExporter for more details on how to
+run excelExporter.

 ## Arduino sample integration ##

@@ -84,14 +100,15 @@

 make --version

-GNU make 3.81 should respond. Now CD to the root directory of the Arduino
-sample and type
+GNU make 3.81 should respond. Now CD to the root directory
+comFramework/canInterface/components/arduinoSampleIntegration of the
+Arduino sample and type

-make -s clean
+make -s clean  
 make -s build

 to rebuild the sample (which includes the generation of the network database
-dependent C code of the CAN interface). Try make help, too.
+dependent C code of the CAN interface). Try "make help", too.

 Please refer to file readMe.md in the root of the Arduino sample for
 further details.
@@ -106,15 +123,16 @@
 Linux and Mac OS as well. If problems appear you should first have a look
 into sub-makefile locateTools.mk, which is responsible to find the paths
 to the executables. There are different configuration possibilities to
-find the tools either via system search path or via environment variables
+find the tools either via system search path or via environment variable
 settings. Maybe you need to alter this configuration first. The same holds
 if you have different GCC revisions installed and want to switch between
 them.

 If GNU make 3.81 and GCC are installed then you can CD to the root
-directory of the Windows sample integration and type
+directory comFramework/canInterface/components/winSampleIntegration of the
+Windows sample integration and type

-make -s clean
+make -s clean  
 make -s build

 to rebuild the sample (which includes the generation of the network database

Installation modified by Peter Vranken

Peter Vranken — Thu, 26 Nov 2015 21:52:13 -0000

--- v2
+++ v3
@@ -12,7 +12,7 @@

 The downloaded comFramework archive contains source files for integration
 in target projects, the Java application, that implements the code
-generator, which supports the interface design and two sample
+generator, which supports the interface design, and two sample
 integrations.

 The source files for integration don't need any installation (with the

Installation modified by Peter Vranken

Peter Vranken — Sun, 27 Sep 2015 21:04:51 -0000

--- v1
+++ v2
@@ -91,7 +91,7 @@
 make -s build

 to rebuild the sample (which includes the generation of the network database
-dependent C code of the CAN interface). Try make --help, too.
+dependent C code of the CAN interface). Try make help, too.

 Please refer to file readMe.md in the root of the Arduino sample for
 further details.
@@ -118,7 +118,7 @@
 make -s build

 to rebuild the sample (which includes the generation of the network database
-dependent C code of the CAN interface). Try make --help, too.
+dependent C code of the CAN interface). Try make help, too.

 Please refer to file readMe.md in the root of the Windows sample for
 further details.

Installation modified by Peter Vranken

Peter Vranken — Sun, 27 Sep 2015 20:30:04 -0000

Installation

Table of contents:

Installation

Overview

comFramework is distributed as a ZIP archive. The initial installation
step is unzipping the contents to a directory of your choice. The
directory should grant read and write access to all users.

The downloaded comFramework archive contains source files for integration
in target projects, the Java application, that implements the code
generator, which supports the interface design and two sample
integrations.

The source files for integration don't need any installation (with the
trivial exception of a text editor to open and read them).

The code generator is always needed. It's installation means to set an
environment variable and optionally to extend the system's search path.

The sample integrations come along with the generated C source code. They
are mainly meant as instructive sample code. An installation of tools is
not required if this suffices, if there's no need or intention to alter
the sample code and re-compile it.

The Arduino sample comes along even with the compiled executable, you can
directly upload it to your Arduino Mega 2560 board and see how it behaves.

If the Windows example should be needed as a running application for
further investigation or debugging then GCC needs to be installed. 32 and
64 Bit versions are supported but only a few versions of GCC have been
tested.

Compilation of the Windows sample has been done under Windows 7 only. The
code is free of specific operation system calls and only uses functions
from the GCC libraries. As these are widely operation system independent
the sample should compile and run under other Windows versions, Linux and
Mac OS as well; this has however never been tested and as a matter of
experience most often there are some minor incompatibilities, which have
to be sorted out first - just give it a try. Feedback is welcome.

Using another compiler than GCC will mean code changes in the application
interface, command line evaluation in the first place.

All C compilation and related operations is controlled from makefiles,
which need GNU make 3.81. If you type make --version in a shell window
this revision of make needs to respond. Other make derivates or elder
revisions of GNU make won't work.

Code generator

The installation of the code generator is described in detail in file
installation.txt; the file can be found locally as
comFramework/codeGenerator/doc/installation.txt.

Please refer to the files readMe.txt in any of the root directories of the
samples, which come along with the code generator for more details on how
to run the code generator.

Arduino sample integration

Arduino 1.0.5 needs to be installed for compilation of the sample and even
for upload of the pre-compiled binary. (The GCC avr tools are taken from the
Arduino installation.) Please refer to http://www.arduino.cc/.

Caution: Do not install the more recent revision Arduino 1.6.5: This
package no longer contains all required GCC avr tools.

A new environment variable needs to be set. Let ARDUINO_HOME point to the
root directory of the Arduino 1.0.5 installation. All tools are located
via this variable.

Modify the system path variable, so that GNU make 3.81 is found when
typing make. Having Arduino 1.0.5 installed this will mean to add
.../arduino-1.0.5/hardware/tools/avr/utils/bin to environment variable
PATH.

In a shell window type

make --version

GNU make 3.81 should respond. Now CD to the root directory of the Arduino
sample and type

make -s clean
make -s build

to rebuild the sample (which includes the generation of the network database
dependent C code of the CAN interface). Try make --help, too.

Please refer to file readMe.md in the root of the Arduino sample for
further details.

Windows sample integration

GNU make 3.81 needs to be installed. GCC (32 or 64 Bit) needs to be
installed. Under Windows, only use MinGW distributions. The Cygwin
distributions will probably need some modifications of the makefiles.

On principle, the makefiles are prepared to support the compilation under
Linux and Mac OS as well. If problems appear you should first have a look
into sub-makefile locateTools.mk, which is responsible to find the paths
to the executables. There are different configuration possibilities to
find the tools either via system search path or via environment variables
settings. Maybe you need to alter this configuration first. The same holds
if you have different GCC revisions installed and want to switch between
them.

If GNU make 3.81 and GCC are installed then you can CD to the root
directory of the Windows sample integration and type

make -s clean
make -s build

to rebuild the sample (which includes the generation of the network database
dependent C code of the CAN interface). Try make --help, too.

Please refer to file readMe.md in the root of the Windows sample for
further details.