Update README.md
This commit is contained in:
parent
3b740a5d6f
commit
3348a485df
30
README.md
30
README.md
|
@ -10,17 +10,31 @@ This is an implementation of the Syndicate network protocol (based on
|
||||||
|
|
||||||
First, it depends on Bash-specific shell features.
|
First, it depends on Bash-specific shell features.
|
||||||
|
|
||||||
Second, you'll need the `preserves-tool` program, which `syndicate.sh`
|
Second, you'll need a Syndicate network server ("broker"). The best
|
||||||
uses to slice and dice network packets. It's written in Rust, so you
|
option at present is the Rust-language server. Unfortunately it relies
|
||||||
can get it with:
|
on a few nightly-only features of Rust, so I use `rustup` to get a
|
||||||
|
nightly toolchain, and then use that:
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# and finally the server:
|
||||||
|
cargo +nightly 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
|
cargo install preserves-tools
|
||||||
|
|
||||||
Third, you'll need a Syndicate network server ("broker"). The best
|
|
||||||
option at present is the Rust-language server:
|
|
||||||
|
|
||||||
cargo install syndicate-server
|
|
||||||
|
|
||||||
## Running the demo
|
## Running the demo
|
||||||
|
|
||||||
Start the server in one terminal, in the same directory as the
|
Start the server in one terminal, in the same directory as the
|
||||||
|
|
Loading…
Reference in New Issue