@@ -36,7 +36,10 @@ The current list of supported devices includes:
3636- MasterKeys Pro L RGB ISO (untested)
3737
3838If you would like for your device to be supported as well, please run
39- the ` record ` executable.
39+ the ` record ` executable. Enter the row and column coordinates of each
40+ key according to the Cooler Master reference each time for the key that
41+ lights up in red. The shared ` layout.c ` can be attached to an issue, and
42+ then your device is added in no-time!
4043
4144Keyboards with only monochrome lighting may use a different protocol and
4245thus they would probably require more modifications than just adding a
@@ -50,20 +53,22 @@ To be able to compile and install any of the targets in this library,
5053distribution, the name of the packages (if they are provided) may
5154differ from the ones given here. The reference commands are for Ubuntu.
5255``` bash
53- # Include libx11-dev if you wish to run the ambilight example
54- sudo apt-get install cmake libusb-1.0.0-dev
56+ # libx11-dev is for the AmbiLight and notifications examples
57+ # python3-gtk2.0 is for the notifications example
58+ sudo apt-get install cmake libusb-1.0.0-dev libx11-dev python3-gtk2.0
5559cd Source/masterkeys-linux # Or wherever you have cloned the repo
56- # Automatically also builds target ambilight
57- # Exclude the examples in the CMakeLists.txt if you do not have libx11-dev
60+
61+ # Builds library, utilities and C examples
62+ # Exclude them from the file if you don't want them to be built
5863cmake .
5964make
6065sudo make install
6166
62- # For the Python library (system-wide install)
67+ # For the Python library (system-wide install) and Python examples
6368sudo python -m pip install scikit-build
64- sudo python setup.py install
69+ sudo python setup.py build install # Python examples not installed
6570
66- # Or if you would rather install from PyPI
71+ # Or if you would rather install from PyPI, still requires dependencies
6772sudo python -m pip install masterkeys
6873```
6974
@@ -107,7 +112,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
107112```
108113
109114## Credits
110- Part of the implementation of this library is based on the more
115+ Part of the implementation of the ` libmk ` library is based on the more
111116extensive protocol description written by [ ` chmod222 ` ] ( https://github.com/chmod222 ) ,
112117available under the LGPLv3 license in [ ` libcmmk ` ] ( https://github.com/chmod222/libcmmk ) ,
113118which has the same goal as this project.
0 commit comments