Skip to content

Commit 698fc50

Browse files
committed
update readme
1 parent 4d2e9be commit 698fc50

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
.idea/
2+
.vscode
3+
4+
/SerialToTCPBridgeProtocol
5+
/SerialToTCPBridgeProtocol.exe

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,15 @@ The following clients are also available:
2222
| [ArduinoSerialToTCPBridgeClient](https://github.com/RoanBrand/ArduinoSerialToTCPBridgeClient) | Arduino | C++ |
2323
| [STM32SerialToTCPBridgeClient](https://github.com/RoanBrand/STM32SerialToTCPBridgeClient) | STM32 | C |
2424

25-
#### Build and Run
25+
#### Get and Run
26+
- Check the releases page for the latest built binaries.
27+
- Get and configure `config.json`. The serial port in Linux for the Arduino Uno is something like `/dev/ttyACM0`.
28+
29+
#### Development and Building
2630
- Install [Go](https://go.dev/dl/) for your system.
27-
- Run `go install github.com/RoanBrand/SerialToTCPBridgeProtocol@latest` in a terminal.
28-
- Copy *config.json* from the repository and the installed executable `~/go/bin/SerialToTCPBridgeProtocol` to a new folder.
31+
- Clone this repository.
2932
- Edit your local `config.json` and set it according to your Serial port configuration.
30-
- Run the `SerialToTCPBridgeProtocol` executable.
33+
- Debug `example.go` in your IDE, or run `go run example.go` or `go build` for a binary.
3134

3235
#### Details
3336
- The protocol provides the app an in order, duplicates free and error checked byte stream by adding a CRC32 and simple retry mechanism. See [this](https://en.wikibooks.org/wiki/Serial_Programming/Error_Correction_Methods) for background.

0 commit comments

Comments
 (0)