Skip to content

Enhance README with usage details for SSC #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonathanBout merged 1 commit into from
Dec 17, 2025
Merged

Enhance README with usage details for SSC #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Simple Serial Console
_replace `ssc` with the name of your binary, e.g. `ssc-windows-amd64` or `ssc-linux-arm64`_
# Simple Serial Console (SSC)
SSC is exactly what you think it is: A serial console without bloat.
For simple communication you don't need anything else! You can use it to control most 3D-printers, an Arduino and loads more.

You only need to know two things:
1. The baud rate the device expects, which you can usually define manually or find somewhere in the info screen
2. The line endings the device expects. It's not always documented, but usually starting with the default (`LF`) works.


## Usage
_replace `ssc` with the name of your binary, e.g. `ssc-windows-amd64` or `ssc-linux-arm64`, or rename your binary to `ssc`_
```
ssc <port> [<baud rate>] [<newline>]
```
Expand Down