term-owo-cpp/README.md
2024-06-20 15:21:27 +01:00

57 lines
888 B
Markdown

# term-owo-cpp
A simple C++ program that owofies text
## Usage
### normal usage:
```bash
$ ./owo "Hello, world!"
Hewwo, wowld!
```
### from pipe / stdin:
```bash
$ echo "Hello, world!" | ./owo -p
Hewwo, wowld!
```
### from file:
```bash
$ ./owo -f file.txt
Hewwo, wowld!
```
### to file:
```bash
$ ./owo -o output.txt "Hello, world!"
```
### to clipboard:
```bash
$ ./owo -c "Hello, world!"
```
## Building
to build the program, run the following command:
```bash
$ cmake . -B build
$ cd build && make
$ ./owo "Hello, world!"
hewwo, wowld!
```
## Installation
### archlinux:
```bash
$ git clone `https://git.alfieking.dev/acetheking987/term-owo-cpp.git`
$ cd term-owo-cpp
$ makepkg -si
```
### other distros:
download the binary from the releases page or build from source
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details