Skip to content

Commit

Permalink
Add a note for required branch
Browse files Browse the repository at this point in the history
  • Loading branch information
Srlion authored Feb 8, 2025
1 parent fb59917 commit a4fc9cd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ RNDX is a lightweight and efficient library designed to make drawing rounded sha

---

> [!NOTE]
> Currently it only works on `dev` branch, it used to work on `x86-64` but Rubat reverted the changes, so you can only use it on `dev` currently.
## ✨ Why RNDX?

- **Blazing Fast Performance**: Optimized for speed, RNDX is incredibly lightweight and efficient. _(It will get even faster once we [get `mat:SetFloat4()`](https://github.com/Facepunch/garrysmod-requests/issues/2606)!)_
Expand All @@ -22,6 +25,9 @@ RNDX is a lightweight and efficient library designed to make drawing rounded sha

## 🛠️ Get Started

> [!NOTE]
> Currently it only works on `dev` branch, it used to work on `x86-64` but Rubat reverted the changes, so you can only use it on `dev` currently.
1. Download `RNDX.tar.gz` & `rndx.lua` from [GitHub releases](https://github.com/Srlion/RNDX/releases/latest).
2. Add the content of `RNDX.tar.gz` to your **gmod client** `garrysmod` folder. (Temporarily until we get `thirdparty` support!)
3. `AddCSLuaFile` & `include` `rndx.lua`.
Expand Down

0 comments on commit a4fc9cd

Please sign in to comment.