ad2cc94fcfa9945d703d92e51958d6526bb4da98
Updated development instructions for contributing to the project.
Usage
Usage: mikusays [OPTIONS] [TEXT]
Arguments:
[TEXT] Text to display in the speech bubble
Options:
-s, --style <STYLE> Style of the Miku art. A random one is chosen if not specified
-l, --list List all available art styles with their indices
--rainbow Apply a smooth rainbow gradient across the ASCII art
--saturation <SATURATION> Saturation level for rainbow gradient (0-100) [default: 100]
--brightness <BRIGHTNESS> Brightness level for rainbow gradient (0-100) [default: 50]
--color <COLOR> Override with a single solid color
--gradient <START:END> Define a custom two-color gradient (e.g., --gradient red:blue)
--no-color Disable all coloring (respects NO_COLOR environment variable)
-h, --help Print help
-V, --version Print version
Installation
Arch Linux
yay -S mikusays
paru -S mikusays
Debian / Ubuntu / Fedora / RHEL / CentOS
The repository and instructions available here: https://apt.xxanqw.pp.ua
macOS (or Linux if using Homebrew)
brew tap xxanqw/mikusays
brew install mikusays
Windows
-
Using Scoop:
scoop bucket add extras scoop bucket add xxanqw-bucket https://github.com/xxanqw/scoop-bucket scoop update scoop install mikusays -
Using Installer:
Download
mikusays-windows-inst-any-x.x.x.exefrom Latest release page
Download from Releases:
- Windows:
mikusays-windows-*.exe- Small note for Windows that application depends on
vcredist2022
(installing with scoop and installer resolve this dependency automatically)
- Small note for Windows that application depends on
- Linux:
mikusays-linux-* - macOS:
mikusays-macos-*
Or build from source:
cargo build --release
Development
-
Fork repository
-
Clone your fork
-
Implement your changes
-
If needed, write tests (it would be great)
-
Run your code with your changes
cargo run -- [your implemented methods, or just text if it's ASCII only]. -
Run the tests
cargo test -
Check your code quality with:
cargo clippy -- -D warningsFix any errors that appear
-
Finally, run the formatter:
cargo fmt
- Commit and push your changes
- Open a pull request
Now you're a contributor!
Description
A rewrite of a "cowsay" clone with Hatsune Miku ASCII art and speech bubbles.
666 KiB
0 Stars
1 Watchers
0 Forks