speckij
/
Hochwasser
mirror of https://github.com/SpeckiJ/Hochwasser.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update readme

This commit is contained in:
Norwin Roosen 2020-12-31 13:44:45 +01:00
parent 8a1e56ba1b
commit 2cd2e694ff
No known key found for this signature in database
GPG Key ID: 24BC059DE24C43A3
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,14 +1,22 @@
<h1 align="center" >🌊🌊🌊 Hochwasser 🌊🤽🌊</h1> <h1 align="center" >🌊🌊🌊 Hochwasser 🌊🤽🌊</h1>
<p align="center"><img src="benchmarks/hochwasser_shuffle_vs_ordered.gif"/></p> <p align="center"><img src="benchmarks/hochwasser_shuffle_vs_ordered.gif"/></p>
Highly efficient client for [Pixelflut]: Highly efficient, distributed [Pixelflut] client.
Faster than [sturmflut]! (In some benchmarks at least)
Can currently only send a single picture though. - Can send static images, text, generated patterns (animations upcoming)
- REPL enables fast iterations
- CnC server + client architecture (canalso runs in a single process)
- Faster than [sturmflut]! (in some benchmarks at least)
- No dependencies (pixelflut apparently was considered a primary use case in the design of golang's stdlib 👍)
[pixelflut]: https://cccgoe.de/wiki/Pixelflut [pixelflut]: https://cccgoe.de/wiki/Pixelflut
[sturmflut]: https://github.com/TobleMiner/sturmflut [sturmflut]: https://github.com/TobleMiner/sturmflut
## build / install
1. have a `go` installation >= 1.12
2. `go get github.com/SpeckiJ/Hochwasser`
3. `go install github.com/SpeckiJ/Hochwasser`
## benchmark ## benchmark
The following benchmark was run on a max-spec X280 against version [d4c574b]. The following benchmark was run on a max-spec X280 against version [d4c574b].
@ -18,8 +26,8 @@ to be CPU limited, as turbo-boost doesn't kick in.
To reproduce, run the following commands in separate shells: To reproduce, run the following commands in separate shells:
```sh ```sh
iperf -s -p 1337 iperf -s -p 1234
go run main.go -image benchmark/test.png -connection 10 go run main.go -image benchmark/test.png -connections 10
``` ```
![screenshot: 55 Gbps of hochwasser](benchmarks/benchmark_x280.png) ![screenshot: 55 Gbps of hochwasser](benchmarks/benchmark_x280.png)