Installing fKeys

You can install fKeys using a prebuilt package, or by using the source. Both ways start with downloading a disk image, which will contain both a prebuilt package and the source code.


Installing with a package

This is the easiest way by far. Download a disk image, open it, then read the ReadMe contained in the disk image and follow the directions.

More documentation is available in the source .tgz, as well.

If You're Installing a Beta

In addition to the ReadMe.rtf document, beta releases will also contain a Beta.rtf document. READ BOTH! Additionally, the documentation in the source .tgz wouldn't be a bad idea to check out, though it's normally crucial only for people trying to make changes.


Installing from source

Note that you will need Xcode to compile fKeys. At present only Xcode 2.4.1 on Tiger 10.4.10 is known to work.

Download a disk image and open it. There will be a .tgz file containing a gzipped tarfile of the source. Gunzip and untar; you'll find a new directory with the same name as the tarfile, minus the '.tgz'. In that directory is a file named INSTALL with all the instructions for building from source.

Note to 0.0.1 users

If you installed fKeys 0.0.1, you will need to manually remove it after installing any later version of fKeys. In an Xterm or Terminal window type:

    sudo rm -rf /opt/kodachi

to remove fKeys 0.0.1.


Problems

If you have any problems, first check this website to see if your question has already been answered. If not, your best bet is to send some email to fkeys at kodachi dot com.

If you send email: be specific. Give your MacOS X version, the version of fKeys, what you did, what you expected to happen, and what actually happened. If at all possible, also include the output of

    grep fKeys /var/log/system.log

as well; that will be an enormous help in figuring out what's going on.