11# rxpipes
22This program is a 2D screensaver which recreates the Pipes screensaver from old MS Windows versions.
33
4- ![ First screenshot of the screensaver] ( screenshots/screenshot_1.png )
5- ![ Second screenshot of the screensaver] ( screenshots/screenshot_2.png )
6-
74## Features
85- Multiple sets of pieces (see the [ Piece Sets] ( #piece-sets ) section to see them)
96- Each pipe has its own color, the available palettes are: none (colorless), base colors and RGB.
@@ -14,17 +11,23 @@ This program is a 2D screensaver which recreates the Pipes screensaver from old
1411Specifying 0 will make this program to draw straight pipes and 1 will make your screen look like...
1512umm... pseudo dragon curve or something like that?
1613
14+ ## Screenshots
15+
16+ ![ First screenshot of the screensaver] ( screenshots/screenshot_1.png )
17+ ![ Second screenshot of the screensaver] ( screenshots/screenshot_2.png )
18+
19+
1720## Installation
18- You'll need the Rust toolchain ([ rustup] ( https://rustup.rs/ ) or from system package repo)
19- and make sure that it's up to date.
21+ You'll need the Rust toolchain ([ rustup] ( https://rustup.rs/ ) or from system package repo) and make
22+ sure it's up to date.
23+
24+ When the toolchain will be prepared, type ` cargo install rxpipes ` .
2025
21- Once you have the toolchain prepared, type ` cargo install rxpipes ` . If the process went well, you
22- can now run the rxpipes simply by typing ` rxpipes ` . If the shell says that the command does not
23- exists, then make sure that ` $HOME/.cargo/bin ` (or whatever the default cargo dir will be) is in the
24- ` PATH ` environment variable.
26+ If you have installed successfully rxpipes, you can now run the it simply by typing ` rxpipes ` . If
27+ the shell says that the command does not exists, make sure that ` $HOME/.cargo/bin ` (or whatever the
28+ default cargo dir will be) is in the ` PATH ` environment variable.
2529
26- ## Running
27- Just type ` rxpipes ` .
30+ To see all available options, pass ` -h ` or ` --help ` .
2831
2932## Controls
3033| Key | Action |
@@ -45,3 +48,10 @@ You can select a set by passing `-P <ID>` to rxpipes.
4548| 4 | Thin pipes with rounded corners | ![ ] ( screenshots/screenshot_p4.png ) |
4649| 5 | Double pipes | ![ ] ( screenshots/screenshot_p5.png ) |
4750| 6 | Bold pipes | ![ ] ( screenshots/screenshot_p6.png ) |
51+
52+ ## Contribution
53+ If you have found a problem or have a suggestion, feel free to open an issue or send a pull request.
54+ I'd appreciate it.
55+
56+ ## License
57+ The rxpipes project is licensed under the [ MIT license] ( LICENSE.md ) .
0 commit comments