Skip to content

Commit d406f1c

Browse files
rokathrokath
committed
Chapter 10 reworked
1 parent ea439b4 commit d406f1c

1 file changed

Lines changed: 109 additions & 91 deletions

File tree

β€Ždocs/TriceUserManual.mdβ€Ž

Lines changed: 109 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@
1111
<h2>Table of Contents</h2>
1212
<details><summary>(click to expand)</summary><ol><!-- TABLE OF CONTENTS START -->
1313

14+
<!--
15+
PDF Generation
16+
* Install vsCode extension "Markdown PDF"
17+
* Use Shift-Command-P "markdown PDF:export" to generata a PDF
18+
* page break for PDF generation: <div style="page-break-before: always;"></div>
19+
-->
20+
1421
<!--
1522
Table of Contents Generation:
1623
* Install vsCode extension "Markdown TOC" from dumeng
@@ -19,6 +26,48 @@ Table of Contents Generation:
1926
* replace "##" followed by 2 spaces with "## "β€š
2027
-->
2128

29+
<!--
30+
```diff
31+
- text in red
32+
-- text in red
33+
+ text in green
34+
++ text in green
35+
! text in orange
36+
!! text in orange
37+
# text in gray
38+
## text in gray
39+
@ text in purple
40+
@@ text in purple
41+
```
42+
43+
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
44+
45+
πŸŸ’βœ…πŸŸ‘β›”πŸ”΄πŸ”΅πŸ’§β“β†©ΰ·΄βš“πŸ›‘β—πŸŒ‘β±βˆ‘βœ³β€Όβ™¦β™£πŸš«βš πŸŽ₯πŸ“·πŸŒŠπŸ†˜πŸ§·πŸ’βž‘β˜•
46+
βš™οΈπŸ§­πŸ”πŸ§ 
47+
48+
RED APPLE (&#x1F34E;): 🍎
49+
GREEN APPLE (&#x1F34F;): 🍏
50+
BLUE HEART (&#x1F499;): πŸ’™
51+
GREEN HEART (&#x1F49A;): πŸ’š
52+
YELLOW HEART (&#x1F49B;): πŸ’›
53+
PURPLE HEART (&#x1F49C;): πŸ’œ
54+
GREEN BOOK (&#x1F4D7;): πŸ“—
55+
BLUE BOOK (&#x1F4D8;): πŸ“˜
56+
ORANGE BOOK (&#x1F4D9;): πŸ“™
57+
LARGE RED CIRCLE (&#x1F534;): πŸ”΄
58+
LARGE BLUE CIRCLE (&#x1F535;): πŸ”΅
59+
LARGE ORANGE DIAMOND (&#x1F536;): πŸ”Ά
60+
LARGE BLUE DIAMOND (&#x1F537;): πŸ”·
61+
SMALL ORANGE DIAMOND (&#x1F538;): πŸ”Έ
62+
SMALL BLUE DIAMOND (&#x1F539;): πŸ”Ή
63+
UP-POINTING RED TRIANGLE (&#x1F53A;): πŸ”Ί
64+
DOWN-POINTING RED TRIANGLE (&#x1F53B;): πŸ”»
65+
UP-POINTING SMALL RED TRIANGLE (&#x1F53C;): πŸ”Ό
66+
DOWN-POINTING SMALL RED TRIANGLE (&#x1F53D;): πŸ”½
67+
68+
https://apps.timwhitlock.info/emoji/tables/unicode
69+
-->
70+
2271
<!-- vscode-markdown-toc -->
2372
* 1. [Abstract](#abstract)
2473
* 2. [A brief history of Trice](#a-brief-history-of-trice)
@@ -1421,59 +1470,71 @@ git ls-tree -r HEAD --name-only | perl -ne 'print $1 if m/\.([^.\/]+)$/' | sort
14211470
## 10. <a id='build-trice-tool-from-go-sources-(you-can-skip-that)'></a>Build Trice tool from Go sources (you can skip that)
14221471

14231472
* Install [Go](https://golang.org/).
1424-
* Extend PATH variable with `~/go/bin`
1425-
* On Windows you need to install [TDM-GCC](https://jmeubank.github.io/tdm-gcc/download/) if you wish to execute the CGO tests as well.
1426-
* Take the 64-bit variant when Go is 64-bit or take the 32-bit variant when Go is 32-bit. If mixed installations work I doubt.
1427-
* Recommendation: Minimal online installer.
1428-
* GCC is only needed to test the target C-code on the host.
1429-
* Make sure TDM-GCC is found first in the path, if you have several compilers installed.
1430-
* Other gcc variants could work also but not tested.
1431-
* Open a console inside the Trice directory, recommended is the git-bash, when using Windows.
1432-
* Check and install:
1473+
* Run:
14331474

1434-
```b
1435-
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1436-
$ go clean -cache
1437-
1438-
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1439-
$ go vet ./...
1440-
1441-
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1442-
$ go test ./...
1443-
? github.com/rokath/trice/cmd/cui [no test files]
1444-
ok github.com/rokath/trice/cmd/stim 0.227s
1445-
ok github.com/rokath/trice/cmd/trice 0.577s
1446-
ok github.com/rokath/trice/internal/args 0.232s
1447-
ok github.com/rokath/trice/internal/charDecoder 0.407s
1448-
ok github.com/rokath/trice/internal/com 1.148s
1449-
ok github.com/rokath/trice/internal/decoder 0.412s [no tests to run]
1450-
? github.com/rokath/trice/internal/do [no test files]
1451-
ok github.com/rokath/trice/internal/dumpDecoder 0.388s
1452-
ok github.com/rokath/trice/internal/emitter 0.431s
1453-
ok github.com/rokath/trice/internal/id 0.421s
1454-
ok github.com/rokath/trice/internal/keybcmd 0.431s
1455-
ok github.com/rokath/trice/internal/link 0.404s
1456-
ok github.com/rokath/trice/internal/receiver 0.409s
1457-
ok github.com/rokath/trice/internal/tleDecoder 0.398s
1458-
? github.com/rokath/trice/internal/translator [no test files]
1459-
ok github.com/rokath/trice/internal/trexDecoder 0.391s
1460-
ok github.com/rokath/trice/pkg/cipher 0.377s
1461-
ok github.com/rokath/trice/pkg/endian 0.302s
1462-
ok github.com/rokath/trice/pkg/msg 0.299s
1463-
ok github.com/rokath/trice/pkg/tst 0.406s
1464-
```
1475+
```bash
1476+
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1477+
$ go install ./cmd/trice/
1478+
```
14651479

1466-
To execute the target code tests, you can run `testAll.sh` or `cd` into `_test` and run `go test ./...` from there. ATTENTION: These tests run a significant long time (many minutes depending on your machine), because the **Go** - **C** border is crossed very often.
1467-
The last tests can last quite a while, depending on your machine.
1480+
* Afterwards you should find an executable `trice` inside `~/go/bin`.
1481+
* Extend PATH variable with `~/go/bin` **OR** copy the Trice binary from there into a folder of your path.
1482+
* Check:
14681483

1469-
```bash
1470-
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1471-
$ go install ./cmd/trice/
1472-
```
1484+
```bash
1485+
ms@PaulPCWin11 MSYS ~/repos/trice (master)
1486+
$ /c/Users/ms/go/bin/trice.exe version
1487+
version=devel, built 2025-10-16 14:46:40.1465337 +0200 CEST
1488+
1489+
ms@PaulPCWin11 MSYS ~/repos/trice (master)
1490+
```
14731491

1474-
Afterwards you should find an executable `trice` inside $GOPATH/bin/ and you can modify its source code.
1492+
* Hints
1493+
* Use only the master branch. Other branches may be inconsistent.
1494+
* Give each Trice binary its own name when using different images. Otherwise you always get what is found first in the **$PATH**.
1495+
* Use Goreleaser if you wish to create releases on your forked Trice repository.
1496+
* On Windows you need to install [TDM-GCC](https://jmeubank.github.io/tdm-gcc/download/) if you wish to execute the CGO tests as well.
1497+
* Take the 64-bit variant when Go is 64-bit or take the 32-bit variant when Go is 32-bit. If mixed installations work I doubt.
1498+
* Recommendation: Minimal online installer.
1499+
* GCC is only needed to test the target C-code on the host.
1500+
* Make sure TDM-GCC is found first in the path, if you have several compilers installed.
1501+
* Other gcc variants could work also but not tested.
1502+
* Open a console inside the Trice directory, recommended is the git-bash, when using Windows.
1503+
* Tests:
1504+
1505+
```b
1506+
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1507+
$ go clean -cache
1508+
1509+
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1510+
$ go vet ./...
1511+
1512+
ms@DESKTOP-7POEGPB MINGW64 /c/repos/trice (master)
1513+
$ go test ./...
1514+
? github.com/rokath/trice/cmd/cui [no test files]
1515+
ok github.com/rokath/trice/cmd/stim 0.227s
1516+
ok github.com/rokath/trice/cmd/trice 0.577s
1517+
ok github.com/rokath/trice/internal/args 0.232s
1518+
ok github.com/rokath/trice/internal/charDecoder 0.407s
1519+
ok github.com/rokath/trice/internal/com 1.148s
1520+
ok github.com/rokath/trice/internal/decoder 0.412s [no tests to run]
1521+
? github.com/rokath/trice/internal/do [no test files]
1522+
ok github.com/rokath/trice/internal/dumpDecoder 0.388s
1523+
ok github.com/rokath/trice/internal/emitter 0.431s
1524+
ok github.com/rokath/trice/internal/id 0.421s
1525+
ok github.com/rokath/trice/internal/keybcmd 0.431s
1526+
ok github.com/rokath/trice/internal/link 0.404s
1527+
ok github.com/rokath/trice/internal/receiver 0.409s
1528+
ok github.com/rokath/trice/internal/tleDecoder 0.398s
1529+
? github.com/rokath/trice/internal/translator [no test files]
1530+
ok github.com/rokath/trice/internal/trexDecoder 0.391s
1531+
ok github.com/rokath/trice/pkg/cipher 0.377s
1532+
ok github.com/rokath/trice/pkg/endian 0.302s
1533+
ok github.com/rokath/trice/pkg/msg 0.299s
1534+
ok github.com/rokath/trice/pkg/tst 0.406s
1535+
```
14751536

1476-
After installing Go, in your home folder should exist a folder ./go/bin. Please add it to your path variable. OR: Copy the Trice binary from there into a folder of your path after creating it with `go install ./cmd/trice/...`
1537+
* To execute the target code tests, you can run `testAll.sh` or `cd` into `_test` and run `go test ./...` from there. ATTENTION: These tests run a significant long time (many minutes depending on your machine), because the **Go** - **C** border is crossed very often.
14771538

14781539
<p align="right">(<a href="#top">back to top</a>)</p>
14791540

@@ -6837,46 +6898,3 @@ Configure `TriceAssert` like macros and this works also with the `-salias` switc
68376898

68386899
<p align="right">(<a href="#top">back to top</a>)</p>
68396900

6840-
6841-
<!--
6842-
6843-
```diff
6844-
- text in red
6845-
-- text in red
6846-
+ text in green
6847-
++ text in green
6848-
! text in orange
6849-
!! text in orange
6850-
# text in gray
6851-
## text in gray
6852-
@ text in purple
6853-
@@ text in purple
6854-
```
6855-
6856-
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
6857-
6858-
πŸŸ’βœ…πŸŸ‘β›”πŸ”΄πŸ”΅πŸ’§β“β†©ΰ·΄βš“πŸ›‘β—πŸŒ‘β±βˆ‘βœ³β€Όβ™¦β™£πŸš«βš πŸŽ₯πŸ“·πŸŒŠπŸ†˜πŸ§·πŸ’βž‘β˜•
6859-
6860-
RED APPLE (&#x1F34E;): 🍎
6861-
GREEN APPLE (&#x1F34F;): 🍏
6862-
BLUE HEART (&#x1F499;): πŸ’™
6863-
GREEN HEART (&#x1F49A;): πŸ’š
6864-
YELLOW HEART (&#x1F49B;): πŸ’›
6865-
PURPLE HEART (&#x1F49C;): πŸ’œ
6866-
GREEN BOOK (&#x1F4D7;): πŸ“—
6867-
BLUE BOOK (&#x1F4D8;): πŸ“˜
6868-
ORANGE BOOK (&#x1F4D9;): πŸ“™
6869-
LARGE RED CIRCLE (&#x1F534;): πŸ”΄
6870-
LARGE BLUE CIRCLE (&#x1F535;): πŸ”΅
6871-
LARGE ORANGE DIAMOND (&#x1F536;): πŸ”Ά
6872-
LARGE BLUE DIAMOND (&#x1F537;): πŸ”·
6873-
SMALL ORANGE DIAMOND (&#x1F538;): πŸ”Έ
6874-
SMALL BLUE DIAMOND (&#x1F539;): πŸ”Ή
6875-
UP-POINTING RED TRIANGLE (&#x1F53A;): πŸ”Ί
6876-
DOWN-POINTING RED TRIANGLE (&#x1F53B;): πŸ”»
6877-
UP-POINTING SMALL RED TRIANGLE (&#x1F53C;): πŸ”Ό
6878-
DOWN-POINTING SMALL RED TRIANGLE (&#x1F53D;): πŸ”½
6879-
6880-
https://apps.timwhitlock.info/emoji/tables/unicode
6881-
6882-
-->

0 commit comments

Comments
Β (0)