From 1e29a422b03fe5facecc6007485cebb5566ffac8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Sun, 19 Apr 2020 21:04:15 +0200 Subject: [PATCH] Add usage section to README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e943633..bcb9590 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,13 @@ Aims to implements the [UDP BitTorrent protocol](https://libtorrent.org/udp_trac Supports IPv4 and IPv6. -There is currently no support for a info hash black- or whilelist. +## Usage + +Install rust compiler (stable is fine) and cmake. Then, compile and run aquatic: + +```sh +./scripts/run-server.sh +``` ## Benchmarks