aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMosder <xmosder12@gmail.com>2026-04-09 19:44:11 +0200
committerMosder <xmosder12@gmail.com>2026-04-09 19:44:11 +0200
commit35dc15a03ba5cf2dec10d63a1fdc7ab1fb082899 (patch)
tree7c6a130760859665b7954e01e5ed1bd72d816bec /README.md
Add README for what to be of this project
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d64ae9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# A (to be) bare-bones analyzer for the game Broken Ranks
+
+Yet to be implemented, analyzer for the game Broken Ranks.
+Inspired by [BrokenHUD](https://github.com/Brok3nSign/BrokenTools/releases).
+Will definitely be way more primitive than the one it's inspired on, because I just can't be bothered to add all those features.
+Unless you value FOSS or have troubles setting up BrokenHUD on your linux system, then you should use [it](https://github.com/Brok3nSign/BrokenTools/releases) instead.