dchat: added README

This commit is contained in:
lunar-mining
2022-08-01 12:15:58 +02:00
parent b3cb2bf147
commit c9f6121d11

45
example/dchat/README.md Normal file
View File

@@ -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
```