Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
supermari0 committed Nov 12, 2015
1 parent 1373033 commit a198b3b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,18 @@ WizardKeys v0.1
By Mario Villaplana

HOW TO COMPILE AND RUN:

Type the following commands in terminal while in the folder holding WizardKeys:

```
gcc -o WizardKeys WizardKeys.c -framework IOKit -framework ApplicationServices
-framework CoreFoundation
./WizardKeys
sudo ./WizardKeys
```

sudo is needed because certain versions of OS X require root permissions to
create the event tap.

This is a keyboard mod for Mac laptops running OS X 10.6 and above. Every time
you press a key with WizardKeys running in the background, the program switches
Expand All @@ -17,9 +24,6 @@ A small API for modifying and reading keyboard LED brightness programatically
is also included in MacKeyLEDAPI.h/c. Feel free to use this in your own
projects.

Warning: WizardKeys has only been tested on a MacBook Pro 5,5 running OS X
10.6.8. No functionality is guaranteed, especially on different platforms.

TODO if I continue working on this hack:
0. Create a Makefile.
1. Make a nice package/daemon with a small GUI.
Expand Down

0 comments on commit a198b3b

Please sign in to comment.