From fbc72751231a73f964428680645366df61c0fbef Mon Sep 17 00:00:00 2001 From: Tea Age Date: Thu, 20 Feb 2020 12:12:28 +0100 Subject: [PATCH] delivery improved --- .goreleaser.yml | 14 ++++++++------ .vscode/launch.json | 2 +- README.md | 10 +++++----- doc/ReadMe.md | 4 ++-- .../triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvoptx | 2 +- .../MDK-ARM/triceDemoF030R8.uvprojx | 4 ++-- {scrC => src.C}/proj_config.h | 0 {scrC => src.C}/trice.c | 0 {scrC => src.C}/trice.h | 0 9 files changed, 19 insertions(+), 17 deletions(-) rename {scrC => src.C}/proj_config.h (100%) rename {scrC => src.C}/trice.c (100%) rename {scrC => src.C}/trice.h (100%) diff --git a/.goreleaser.yml b/.goreleaser.yml index 841213da3..a0ff13580 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -64,8 +64,8 @@ archives: #id: my-archive # Builds reference which build instances should be archived in this archive. - builds: - - default + #builds: + #- default # Replacements for GOOS and GOARCH in the archive name. # Keys should be valid GOOSs or GOARCHs. @@ -90,7 +90,7 @@ archives: # If format is `binary`, no archives are created and the binaries are instead # uploaded directly. # Default is `tar.gz`. - # format: zip + format: tar.gz # Can be used to change the archive formats for specific GOOSs. # Most common use case is to archive as zip on Windows. @@ -106,18 +106,20 @@ archives: - README.md - CHANGELOG.md - doc/**/* + - src.C/**/* checksum: # You can change the name of the checksums file. # Default is `{{ .ProjectName }}_{{ .Version }}_checksums.txt`. #name_template: "{{ .ProjectName }}_checksums.txt" + #name_template: 'checksums.txt' # Algorithm to be used. # Accepted options are sha256, sha512, sha1, crc32, md5, sha224 and sha384. # Default is sha256. #algorithm: sha256 -#snapshot: +snapshot: # Allows you to change the name of the generated snapshot # # Note that some pipes require this to be semantic version compliant (nfpm, @@ -130,11 +132,11 @@ checksum: # You can customize how the changelog is generated using the changelog section in the config file changelog: # set it to true if you wish to skip the changelog generation - #skip: true + #skip: false # could either be asc, desc or empty # Default is empty - #sort: asc + sort: asc filters: # commit messages matching the regexp listed here will be removed from diff --git a/.vscode/launch.json b/.vscode/launch.json index 2997157bc..57e7fe354 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -62,7 +62,7 @@ "env": {}, "args": ["update", "-src", - "C:/GitRepos/GoT/trice/srcC/triceCheck.c" + "C:/GitRepos/GoT/trice/src.C/triceCheck.c" ] } ] diff --git a/README.md b/README.md index a992567b7..d28790a13 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ embedded device C printf-like trace code and real-time PC logging (trace ID visu - as runtime logger or simply for narrow bandwidth logging in the field even with encryption. - Usage is similar to 'printf()', but the format strings go not into the target image. - The needed code instrumentation is minimal: - - Adapt a [config file](./scrC/proj_config.h) (hardware specific). - - Add [one small C-file](./scrC/trice.c) to your project and include a [C-header](./scrC/trice.h) where trices are used. + - Adapt a [config file](./src.C/proj_config.h) (hardware specific). + - Add [one small C-file](./src.C/trice.c) to your project and include a [C-header](./src.C/trice.h) where trices are used. - Core instrumentation needs less 150 bytes FLASH and about 100 bytes RAM. ## `trice` PC tool @@ -55,9 +55,9 @@ embedded device C printf-like trace code and real-time PC logging (trace ID visu - Displays trices in realtime during target runtime. ## Quick setup -- add [trice.c](./scrC/trice.c) as is to your project -- #include [trice.h](./scrC/trice.h) as is in your source file to use trice -- copy [proj_config.h](./scrC/proj_config.h), rename to `config.h` and adapt to your needs +- add [trice.c](./src.C/trice.c) as is to your project +- #include [trice.h](./src.C/trice.h) as is in your source file to use trice +- copy [proj_config.h](./src.C/proj_config.h), rename to `config.h` and adapt to your needs - [triceCheck.c](./examples/triceDemoF030R8/Src/triceCheck.c) is example code and for testing - run `trice u` in root of your C|Cpp source project after code instrumentation with TRICE* statements to generate a prroject specific til.json file diff --git a/doc/ReadMe.md b/doc/ReadMe.md index 6c9861fa0..6e6c78028 100644 --- a/doc/ReadMe.md +++ b/doc/ReadMe.md @@ -66,7 +66,7 @@ Use `-color off` switch for piping output in a file or `-color alternate` for a ---------------|---------------------------------------------------------| cmd/ | the `trice` sources | pkg/ | the internal `trice`packages | -srcC/ | C sources for your embedded project | +src.C/ | C sources for your embedded project | examples/ | example target projects | doc/ | documentation | @@ -77,7 +77,7 @@ doc/ | documentation | ### Instrument a target source code project (How to use trice in your project) - - Include [trice.c](../scrC/trice.c) unchanged into your project and make sure the [trice.h](../scrC/trice.h) header file is found by your compiler. + - Include [trice.c](../src.C/trice.c) unchanged into your project and make sure the [trice.h](../src.C/trice.h) header file is found by your compiler. - Add `#include "trice.h"` to your project files where to use TRICE and put `TRICE0( Id(0), "msg:Hello world!\n" );` after your initialization code. - Run `trice u` at the root of your source code. Afterwards: - The `Id(0)` should have changed into `Id(12345)` as example. (The `12345` stays here for a 16-bit non-zero random number). diff --git a/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvoptx b/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvoptx index 7015e72a8..df16ce381 100644 --- a/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvoptx +++ b/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvoptx @@ -234,7 +234,7 @@ 0 0 0 - ..\..\..\scrC\trice.c + ..\..\..\src.C\trice.c trice.c 0 0 diff --git a/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvprojx b/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvprojx index c83d515c1..0bdd70f12 100644 --- a/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvprojx +++ b/examples/triceDemoF030R8/MDK-ARM/triceDemoF030R8.uvprojx @@ -338,7 +338,7 @@ USE_FULL_LL_DRIVER,HSE_VALUE=8000000,HSE_STARTUP_TIMEOUT=100,LSE_STARTUP_TIMEOUT=5000,LSE_VALUE=32768,HSI_VALUE=8000000,LSI_VALUE=40000,VDD_VALUE=3300,PREFETCH_ENABLE=1,INSTRUCTION_CACHE_ENABLE=0,DATA_CACHE_ENABLE=0,STM32F030x8 - ../Inc; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/STM32F0xx_HAL_Driver/Inc; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/CMSIS/Device/ST/STM32F0xx/Include; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/CMSIS/Include; ..\..\..\scrC + ../Inc; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/STM32F0xx_HAL_Driver/Inc; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/CMSIS/Device/ST/STM32F0xx/Include; C:/Users/ms/STM32Cube/Repository/STM32Cube_FW_F0_V1.11.0/Drivers/CMSIS/Include; ..\..\..\src.C @@ -395,7 +395,7 @@ trice.c 1 - ..\..\..\scrC\trice.c + ..\..\..\src.C\trice.c triceCheck.c diff --git a/scrC/proj_config.h b/src.C/proj_config.h similarity index 100% rename from scrC/proj_config.h rename to src.C/proj_config.h diff --git a/scrC/trice.c b/src.C/trice.c similarity index 100% rename from scrC/trice.c rename to src.C/trice.c diff --git a/scrC/trice.h b/src.C/trice.h similarity index 100% rename from scrC/trice.h rename to src.C/trice.h