From a221465e0800aaffbc4f8ae1955451736917706d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim=20Vis=C3=A9e?= <timvisee@gmail.com>
Date: Sat, 30 Dec 2017 20:58:50 +0100
Subject: [PATCH] Polish README

---
 README.md | 37 ++++++++++++++++++++++++++++---------
 1 file changed, 28 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index d7db22b..8a4aabc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # pixelpwnr
-A quick pixelflut client in Rust for use at 34C3.
+A quick [pixelflut][pixelflut] client in [Rust][rust] for use at [34C3][34C3].
 
 **Note:** This is a prototype project. Some things may not work correctly.
 Or some things may work slow.
@@ -19,10 +19,10 @@ Pixelflut a simple image:
 # - With the image: image.png
 # - With 4 painting threads
 # - With a size of (400, 400)
-$ pixelpwnr 127.0.0.1:8080 -i image.png -c 4 -w 400 -h 400
+pixelpwnr 127.0.0.1:8080 -i image.png -c 4 -w 400 -h 400
 
 # Other CLI syntax is also supported
-$ pixelpwnr "127.0.0.1:8080" -i="image.png" -c=4 -w=400 -h=400
+pixelpwnr "127.0.0.1:8080" -i="image.png" -c=4 -w=400 -h=400
 ```
 
 Pixelflut an animated image:
@@ -34,21 +34,20 @@ Pixelflut an animated image:
 # - With 4 painting threads
 # - With a size of (400, 400)
 # - With an offset of (100, 100)
-$ pixelpwnr 127.0.0.1:8080 -i *.png --fps 5 -c 4 -w 400 -h 400 -x 100 -y 100
+pixelpwnr 127.0.0.1:8080 -i *.png --fps 5 -c 4 -w 400 -h 400 -x 100 -y 100
 ```
 
 ## Installation
 For installation, Rust cargo is required.
-Install the latest version of Rust with [rustup](https://rustup.rs/).
+Install the latest version of Rust with [rustup][rustup].
+
+Then, clone and install pixelpwnr with:
 
 ```bash
 # Clone the project
 git clone https://github.com/timvisee/pixelpwnr.git
 cd pixelpwnr
 
-# Build the project (release version)
-cargo build --release
-
 # Install pixelpwnr
 cargo install
 
@@ -59,9 +58,23 @@ pixelpwnr --help
 cargo run --release -- --help
 ```
 
+Or just build it and invoke the binary directly:
+
+```bash
+# Clone the project
+git clone https://github.com/timvisee/pixelpwnr.git
+cd pixelpwnr
+
+# Build the project (release version)
+cargo build --release
+
+# Start using pixelpwnr
+./target/release/pixelpwnr --help
+```
+
 ## Help
 ```text
-$ pixelpwnr --help
+pixelpwnr --help
 
 pixelpwnr 0.1
 Tim Visee <timvisee@gmail.com>
@@ -90,3 +103,9 @@ ARGS:
 ## License
 This project is released under the GNU GPL-3.0 license.
 Check out the [LICENSE](LICENSE) file for more information.
+
+
+[34C3]: https://events.ccc.de/congress/2017/wiki/index.php/Main_Page
+[pixelflut]: https://cccgoe.de/wiki/Pixelflut
+[rust]: https://rust-lang.org/
+[rustup]: https://rustup.rs/