Readmes of samples of code generator reviewed

PeterVranken · Nov 29, 2024 · d4426e9 · d4426e9
1 parent 5a01a2c
commit d4426e9
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 9 deletions.
diff --git a/codeGenerator/samples/AUTOSAR/readMe.adoc b/codeGenerator/samples/AUTOSAR/readMe.adoc
@@ -9,7 +9,7 @@ application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-link:codeGenerator\doc\installation.txt[../../doc/installation.html^],
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
 too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is

diff --git a/.../EmbeddedCoderAPIWithBusStruct/readMe.txt → ...EmbeddedCoderAPIWithBusStruct/readMe.adoc b/.../EmbeddedCoderAPIWithBusStruct/readMe.txt → ...EmbeddedCoderAPIWithBusStruct/readMe.adoc
@@ -67,7 +67,7 @@ The DBC file used in this sample is the same as in the same integrations
 of comFramework's CAN interface. Hence, the specification of the
 functionality of the Simulink model can be found in form of the hand coded
 APSW in the sample integration of the CAN interface. See
-http://svn.code.sf.net/p/comframe/code/canInterface/trunk/sampleIntegrations/winSampleIntegration/code/APSW.
+link:../../../canInterface/sampleIntegrations/winSampleIntegration/code/APSW/pwr_computeEnginePower.c[canInterface/sampleIntegrations/winSampleIntegration/code/APSW/pwr_computeEnginePower.c^]
 
 Note, the pack and unpack functions as essential part of the code generation
 process are not included in the demo application. This sample focuses on
@@ -112,8 +112,8 @@ try. Note, C99 compliance is a must.
 
 To build and execute the demo application type:
 
-cd compileIt
-make run
+  cd compileIt
+  make run
 
 The demo application can be debugged using the script gdb.ps1. The GNU
 debugger needs to be on the system search path.

diff --git a/codeGenerator/samples/iterations/readMe.txt → codeGenerator/samples/iterations/readMe.adoc b/codeGenerator/samples/iterations/readMe.txt → codeGenerator/samples/iterations/readMe.adoc
@@ -11,7 +11,8 @@ installation test of the application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-codeGenerator\doc\installation.txt, too.
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
+too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is
 straightforward.
diff --git a/...tor/samples/mapCanIdToFrameIdx/readMe.txt → ...or/samples/mapCanIdToFrameIdx/readMe.adoc b/...tor/samples/mapCanIdToFrameIdx/readMe.txt → ...or/samples/mapCanIdToFrameIdx/readMe.adoc
@@ -45,7 +45,8 @@ application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-codeGenerator\doc\installation.txt, too.
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
+too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is
 straightforward.
diff --git a/...nerator/samples/raceTechnology/readMe.txt → ...erator/samples/raceTechnology/readMe.adoc b/...nerator/samples/raceTechnology/readMe.txt → ...erator/samples/raceTechnology/readMe.adoc
@@ -11,7 +11,8 @@ application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-codeGenerator\doc\installation.txt, too.
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
+too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is
 straightforward.
diff --git a/codeGenerator/samples/scratchPad/readMe.txt → codeGenerator/samples/scratchPad/readMe.adoc b/codeGenerator/samples/scratchPad/readMe.txt → codeGenerator/samples/scratchPad/readMe.adoc
@@ -10,7 +10,8 @@ application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-codeGenerator\doc\installation.txt, too.
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
+too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is
 straightforward.
diff --git a/...enerator/samples/stringCompare/readMe.txt → ...nerator/samples/stringCompare/readMe.adoc b/...enerator/samples/stringCompare/readMe.txt → ...nerator/samples/stringCompare/readMe.adoc
@@ -10,7 +10,8 @@ application.
 If you want to run the application from another working folder then you
 will have to modify the script: The Windows script references the required
 resources by relative paths from here. Please, refer to
-codeGenerator\doc\installation.txt, too.
+link:../../doc/installation.html[codeGenerator\doc\installation.txt^],
+too.
 
 All Windows scripts are trivial; porting them to Linux or Mac OS is
 straightforward.