readme

2024-06-18 13:16:02 +01:00
parent fbfd0308ca
commit 89af9b499b
1 changed files with 23 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # term-owo-cpp

-A simple C++ program that owofies text
+A simple C++ program that owofies text
+
+## Usage
+
+```bash
+$ ./owo "Hello, world!"
+Hewwo, wowld!
+```
+
+## Building
+
+```bash
+$ g++ -o owo owo.cpp
+```
+
+## Installation
+
+archlinux:
+```bash
+$ git clone `https://git.alfieking.dev/acetheking987/term-owo-cpp.git`
+$ cd term-owo-cpp
+$ makepkg -si
+```