From f4a32f08ccc93c558b5e2776a4efcf8baabb30da Mon Sep 17 00:00:00 2001 From: Tony Garnock-Jones Date: Wed, 12 May 2021 15:43:54 +0200 Subject: [PATCH] README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..930b370 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# mini-syndicate-py + +This is a Python implementation of the Syndicate network protocol. + +It does *not* yet offer a formal Actor or Facet implementation for +Python, nor any Syndicate DSL language extensions. + + pip install mini-syndicate + +or + + git clone https://git.syndicate-lang.org/syndicate-lang/mini-syndicate-py + cd mini-syndicate-py + virtualenv -p python3 pyenv + . pyenv/bin/activate + pip install -r requirements.txt + +## Running + +Start a Syndicate broker (such as +[this one](https://git.syndicate-lang.org/syndicate-rs)) in one window. + +Then, run + + python chat.py tcp://localhost:8001#chat + +several times in separate windows.