Browse Source

Update README.md

main
Tony Garnock-Jones 3 months ago
parent
commit
3348a485df
  1. 28
      README.md

28
README.md

@ -10,16 +10,30 @@ This is an implementation of the Syndicate network protocol (based on
First, it depends on Bash-specific shell features.
Second, you'll need the `preserves-tool` program, which `syndicate.sh`
uses to slice and dice network packets. It's written in Rust, so you
can get it with:
Second, you'll need a Syndicate network server ("broker"). The best
option at present is the Rust-language server. Unfortunately it relies
on a few nightly-only features of Rust, so I use `rustup` to get a
nightly toolchain, and then use that:
cargo install preserves-tools
# compiling syndicate-server from source needs these things:
apt install libssl-dev pkg-config curl
# this is the command-line given by https://rustup.rs/:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# follow the instructions
# then log out and in again
# now you can get the nightly toolchain:
rustup toolchain install nightly
Third, you'll need a Syndicate network server ("broker"). The best
option at present is the Rust-language server:
# and finally the server:
cargo +nightly install syndicate-server
cargo install syndicate-server
Third, you'll need the `preserves-tool` program, which `syndicate.sh`
uses to slice and dice network packets. It's also written in Rust (but
doesn't require nightly), so you can get it with:
cargo install preserves-tools
## Running the demo

Loading…
Cancel
Save