diff --git a/README.md b/README.md new file mode 100644 index 00000000..854bed5e --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# ROG-Core + +rog-core is a utility for Linux to control many aspects (eventually) of the ASUS ROG laptops like the Zephyrus GX502GW. + +The laptop I currently have is the GX502RW and so I'll be using that for the basis of this app. If I get wireshark captures from others with different ROG laptops then I should be able to add something like laptop and feature detection. + +## Use + +Currently requires root for accessing the USB devices (so, sudo). + +Commands are given by: + +``` +rog-core