aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen Chen <[email protected]>2021-05-29 13:37:33 +1000
committerGitHub <[email protected]>2021-05-29 13:37:33 +1000
commitc7ecfc584b2b3a8324e86ab16b2c3979863789f7 (patch)
tree91bdcca87c252a92d7455d49410e64b9b907db7d
parent63579b2301ac97583c9376bb8f4c31ae5c36c54f (diff)
downloadlibrazermacos-c7ecfc584b2b3a8324e86ab16b2c3979863789f7.tar.xz
librazermacos-c7ecfc584b2b3a8324e86ab16b2c3979863789f7.zip
Update README.md
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index c88789c..4b9d0b9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
# librazermacos
+
+C library of openrazer drivers ported to macOS.
+
+Exposed as a shared/dynamic library - `librazermacos.so`.
+
+
+Includes a sample CLI implementation in C to demonstrate driver function calls.
+
+To build the shared library and sample cli
+```bash
+make
+```
+Running the CLI
+```bash
+./sample_cli
+```
+
+To build the shared library only.
+```bash
+make librazermacos.so
+```