updated readme

This commit is contained in:
2024-06-19 16:15:47 +01:00
parent 89af9b499b
commit 53245d19fe
4 changed files with 60 additions and 7 deletions

View File

@@ -4,22 +4,46 @@ A simple C++ program that owofies text
## Usage
### normal usage:
```bash
$ ./owo "Hello, world!"
Hewwo, wowld!
```
## Building
### 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!"
```
## Building
to build the program, run the following command (note that you need g++ installed):
```bash
$ g++ -o owo owo.cpp
```
## Installation
archlinux:
### 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