ditin2/pixelpwnr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Polish README

Browse Source
This commit is contained in:
Tim Visée
2017-12-30 20:58:50 +01:00
parent 86aeb177b6
commit a221465e08
1 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

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