Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.5 KB

README.md

File metadata and controls

85 lines (59 loc) · 2.5 KB

Welcome to shuangpin 👋

Documentation License: MIT Twitter: huqihh

Practice shuangpin in your terminal.

✨ Demo

typer

Install

you can install Go and build from source (requires Go 1.16+):

go install github.com/A11Might/shuangpin@latest

Usage

By default, the natural code scheme is used, and pinyin and key prompts are displayed for random Chinese character practice.

shuangpin

It is recommended for beginners to choose the shuangpin scheme they want to learn, and then use the all sequence mode to practice.

shuangpin -s zrm -m sequence

To get a full overview of all available options, run shuangpin --help.

NAME:
   shuangpin - Practice shuangpin in your terminal

USAGE:
   shuangpin [global options] command [command options] [arguments...]

COMMANDS:
   support, s  View the supported shuangpin schemes and practice mode
   help, h     Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --scheme value, -s value  choose shuangpin scheme (default: "zrm")
   --mode value, -m value    choose practice mode (default: "random")
   --pinyin, -p              disable pinyin prompt (default: false)
   --keyboard, -k            disable key prompt (default: false)
   --help, -h                show help

Author

👤 Kohath Hu

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Kohath Hu.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator