aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorczjstmax <jstmaxlol@disroot.org>2026-05-12 23:39:55 +0200
committerczjstmax <jstmaxlol@disroot.org>2026-05-12 23:39:55 +0200
commit4b368c89b4e411b6e567a8902efa9bb123e50175 (patch)
tree852ee82e4fdb5246e249f3120c08cf5e3c942f9f /README.md
parent8a4a0fb7d032cd725cea00a7b4587faaa8535cea (diff)
de-shittify readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 20 insertions, 13 deletions
diff --git a/README.md b/README.md
index acaa977..0a5c5ad 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,38 @@
-# xsc3🧮
-**xsc3** (e**X**tremely**S**imple**C**alculator **3**): the easiest way to calculate stuff in the terminal \
-syntax: `xsc <num1> <(+|-|x|/|%|^)> <num2>` or `xsc r <num>` \
-pros: supports floating point number operations.. or smth \
-**note**: compile with **g++**
+# xsc3
+
+**xsc3** (e**X**tremely**S**imple**C**alculator **3**): the easiest way to calculate stuff in the terminal
+
+syntax: `xsc <num1> <(+|-|x|/|%|^)> <num2>` or `xsc r <num>`
+
+pros: supports floating point number operations.. or something
+
+## AUR
+
+**xsc3** is now available on the [Arch User Repository](https://aur.archlinux.org/packages/xsc),
-## AUR⭐
-**xsc3** is now available on the [Arch User Repository](https://aur.archlinux.org/packages/xsc), \
install it with your favourite AUR helper:
+
* `yay` : `yay -S xsc`
* `paru` : `paru -S xsc`
* `trizen` : `trizen -S xsc`
* `pamac` : `pamac build xsc`
* `aurman` : `aurman -S xsc`
-## dependenciesšŸ¤“
+## dependencies
+
* `figlet` : `paru -S figlet`
* `lolcat` : `paru -S lolcat`
-## manual installation one-lineršŸ¤–
+## manual installation one-liner
+
#### downloads dependencies, clones repo and compiles **xsc3** ;
+
`paru -S figlet lolcat gcc && git clone https://github.com/jstmaxlol/xsc && cd ./xsc && g++ -o xsc xsc.cpp -O2 -std=c++23`
#### (optional, but recommended for actually using xsc) moves **xsc3** to PATH ;
-`mv ./xsc /usr/bin/xsc` \
+`mv ./xsc /usr/bin/xsc`
if didn't know, adding a binary to PATH makes it so that you do not have to find yourself in the installation path of the binary to execute it!
-## usage⭐
+## usage
+
uhh.. `xsc h` and stfu
-&nbsp;
-###### jstmax@62-69-74-2E-6C-79-2F-6D-78-5F-69-6E-66-6F