n6cta/baecun
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Fixed readme formatting errors

Browse Source
This commit is contained in:
Chris 2025-03-01 00:58:41 -08:00
parent 248e1f0a1c
commit 0e5ef84203
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,6 @@
# baecun
baecun is a Rust-based command-line tool that constructs and sends specially formatted frames to an AGWPE server over TCP. It supports unproto frames with and without digipeaters and provides some validation for IP addresses, ports, callsigns, and channel numbers. This tool was written as an exercise to both learn and be able to teach the building blocks of both rust idomatic programming and writing a simple unproto AGWPE TX client.
baecun is a Rust-based command-line tool that constructs and sends specially formatted frames to an AGWPE server over TCP. It supports unproto frames with and without digipeaters and provides some validation for IP addresses, ports, callsigns, and channel numbers. This tool was written as an exercise to myself both learn and be able to teach the building blocks of both Rust idomatic programming and writing a simple unproto AGWPE TX client.
## Features
@ -24,7 +24,7 @@ Sends the constructed frame to the AGWPE server over a TCP connection.
## Prerequisites
- Rusthttps://www.rust-lang.org/tools/install (version 1.XX or later)
- Rust https://www.rust-lang.org/tools/install (version 1.XX or later)
- Cargo package manager (included with Rust)
## Installation
@ -49,14 +49,14 @@ The compiled executable will be located in the `target/release` directory.
Run the executable with the required arguments:
```bash
baecun -i <IP_ADDRESS> -p -f <FROM_CALL> -t <TO_CALL> -m \"<MESSAGE>\" [OPTIONS]
baecun -i <IP_ADDRESS> -p -f <FROM_CALL> -t <TO_CALL> -m "<MESSAGE>" [OPTIONS]
```
### Command-Line Arguments
- `-i, –ip <IP_ADDRESS>`
The IP address of the AGWPE server.
Example: `192.168.1.100`
Example: `127.0.0.1`
- `-p, –port `
The port number of the AGWPE server (must be greater than 0).