Selaa lähdekoodia

dchat: added README

lunar-mining 4 vuotta sitten
vanhempi
sitoutus
c9f6121d11
1 muutettua tiedostoa jossa 45 lisäystä ja 0 poistoa
  1. 45 0
      example/dchat/README.md

+ 45 - 0
example/dchat/README.md

@@ -0,0 +1,45 @@
+# Dchat
+
+A demo chat program to document DarkFi net
+code. Tutorial can be found in the [DarkFi
+book](https://darkrenaissance.github.io/darkfi/learn/writing-a-p2p-app.html).
+
+## Usage
+
+Spin up a seed node:
+
+```shell
+cd example/dchat-seed
+cargo run
+```
+
+Run dchat as an inbound node:
+
+```shell
+cargo run a
+```
+
+Run dchat as an outbound node:
+
+```shell
+cargo run b
+```
+
+## Logging
+
+Dchat creates a logging file for the inbound node at /tmp/alice.log.
+Logging for the outbound node is found at /tmp/bob.log.
+
+Tail them like so:
+
+```shell
+tail -f /tmp/alice.log
+```
+
+Or use multitail for colored output:
+
+```shell
+multitail -c /tmp/alice.log
+```
+
+