Skip to content

Update README.md with improvements #131

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
gilbert-sci merged 1 commit into from
Jul 21, 2025
Merged

Update README.md with improvements #131

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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Includes `synapsectl` command line utility:
--verbose, -v Enable verbose output

Commands:
{discover,info,query,start,stop,configure,logs,read,plot,file,taps,deploy}
{discover,info,query,start,stop,configure,logs,read,plot,file,taps,deploy,build}
discover Discover Synapse devices on the network
info Get device information
query Execute a query on the device
Expand All @@ -30,6 +30,7 @@ Includes `synapsectl` command line utility:
file File commands
taps Interact with taps on the network
deploy Deploy an application to a Synapse device
build Cross-compile and package an application into a .deb without deploying

As well as the base for a device implementation (`synapse/server`),

Expand All @@ -53,6 +54,8 @@ And a toy device `synapse-sim` for local development,
--serial SERIAL Device serial number
-v, --verbose Enable verbose output

For more information on deploy and build, visit [synapse-example-app](https://github.com/sciencecorp/synapse-example-app)

## A Note on Streaming

Synapse devices stream data to and from clients with UDP. To minimize packet loss, it is highly recommended that users increase their OS UDP buffer size.
Expand Down