summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonetienne <leon@etiennes.de>2022-04-09 15:48:07 +0200
committerLeonetienne <leon@etiennes.de>2022-04-09 15:48:07 +0200
commitf64f7b80400c92f868675af4f1c57c769a815159 (patch)
treef25077851ec19c097b7915e321849cee9ee18f54
parent34f8a6104dfcf62f3ea0ee4ac50ad1e06642fdf0 (diff)
Made a bowing cweawtext readme fiwe, and modified twe cuwwent one
-rw-r--r--readme-cleartext.md43
-rw-r--r--readme.md30
2 files changed, 60 insertions, 13 deletions
diff --git a/readme-cleartext.md b/readme-cleartext.md
new file mode 100644
index 0000000..bf87d5e
--- /dev/null
+++ b/readme-cleartext.md
@@ -0,0 +1,43 @@
+# Uwwwwu<sup>PP</sup>
+
+[![uwu](https://img.shields.io/badge/uwu'd%3F-yes-AA44AA)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/cute%3f-definitely!-44AAFA)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/nyecessawy%3f-you%20bet!-AAAA44)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/license-BSD%202%20Clause-44AA44)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/test%20cuvwage-some-44AA44)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/downloads-%3E1-AA44AA)](https://github.com/Leonetienne/UwwwuPP/releases/tag/1)
+[![uwu](https://img.shields.io/badge/pwatform-evewytwing%20twat%20runs%20cmake-00589D)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/eviw%20pwopwietawy%20softwawe%3f-nyeva%20eva-44AAFA)](https://github.com/Leonetienne/UwwwuPP)
+[![uwu](https://img.shields.io/badge/badges%3f-all%20of%20twem-AA44AA)](https://github.com/Leonetienne/UwwwuPP)
+
+I was looking for an uwwwwwuifier that supported input from
+stdin and from parameters, that doesn't need 500.000 bloated dependencies to work.
+So i made this.
+
+You do have to compile it yourself. I do not fancy providing a hundred different binaries
+for each distribution. But it is really easy.
+
+## Compile instructions
+To do so, make sure you have cmake installed.
+Clone this repository, and install all dependencies via:
+```
+$ git submodule update --init --recursive
+```
+
+If they won't pull, you might have to switch the submodules remotes out for their
+https-variants. They are git@ by default, which requires your ssh to be set up with github.
+Then all you have to do is to start the build:
+```sh
+$ cmake Src -B build
+$ cd build
+$ make
+```
+
+Lastly, verify that your build works correctly:
+```sh
+$ ./Uwwwu Hello, thanks for paying this repository a visit :D
+Hiiiiiiiiiiiii, you're twe best :33 xoxo for paaaying twis repositowy a visit :3
+```
+
+:33333 enyoi <3
+
diff --git a/readme.md b/readme.md
index 92b21d1..9801fb7 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,4 @@
-# Uwwwwu<sUWP>PP</suwp>
+# Uwwwwu<sup>PP</sup>
[![uwu](https://img.shields.io/badge/uwu'd%3F-yes-AA44AA)](https://github.com/Leonetienne/UwwwuPP)
[![uwu](https://img.shields.io/badge/cute%3f-definitely!-44AAFA)](https://github.com/Leonetienne/UwwwuPP)
@@ -10,30 +10,34 @@
[![uwu](https://img.shields.io/badge/eviw%20pwopwietawy%20softwawe%3f-nyeva%20eva-44AAFA)](https://github.com/Leonetienne/UwwwuPP)
[![uwu](https://img.shields.io/badge/badges%3f-all%20of%20twem-AA44AA)](https://github.com/Leonetienne/UwwwuPP)
-I was wooking for an uwwwwwuifier twat suwpported input fwom
-stdin and pawameters, twat doesn't nyeed 500.000 dependencies to work.
+I was looking for an uwwwwwuifia twat suwppowted input fwom
+stdin and fwom pawametews, twat doesn't nyeed 500.000 bwoated dependencies to wowk.
So i made twis.
-You can eitwer compiwe it yoursewf, or downwoad eitwer twe debian, or macos buiwd fwom twe [reweases tab](https://github.com/Leonetienne/UwwwuPP/releases). It shouwd compiwe on evewy pwatform twat suwpports cmake.
+You do haf to compiwe it y-youwsewf. I do nyot fancy pwoviding a hundwed diffewent binyawies
+for each distwibution. But it is reawwy easy.
## Compiwe instwuctions
To do so, make suwe you haf cmake instawwed.
-Clown twis repositowy, and instal all dependencies via:
+Cwone twis repositowy, and install all dependencies via:
```
$ git submodule update --init --recursive
```
-If it won't pull, you might haf to switch twe submoduwes remotes out for tweir https-vawiants. Twey awe git@ by defauwt.
-Twen <3 all you haf to do is to start twe mega ct3.14 buiwd:
-```
-$ cd Src/
-$ cmake . && make
+If tweeey won't pull, you might haf to switch twe submoduwes remotes out for tweir
+https-vawiants. Tweeey awe git@ by defauwt, whiiiiiiich requiwes your ssh to be set uwp witw gitwub.
+Twen all you haf to do is to stawt twe buiwd:
+```sh
+$ cmake Src -B build
+$ cd build
+$ make
```
-Lastwy, vewify twat your buiwd works corwectwy
-```
+Lastwy, vewify twat your buiwd wowks cowwectwy:
+```sh
$ ./Uwwwu Hello, thanks for paying this repository a visit :D
Hiiiiiiiiiiiii, you're twe best :33 xoxo for paaaying twis repositowy a visit :3
```
-:33333 enyoi <3
+:33333 enyyoi <3
+