martin-stone / touchcursor

A keyboard utility that lets you use the home keys (e.g. JKL) as cursor keys -- in all Windows programs -- keeping your fingers in the best position for fast typing.
http://martin-stone.github.io/touchcursor/
GNU General Public License v3.0
164 stars 28 forks source link

TouchCursor Readme

Dependencies

C++ Libraries

The location of these libraries can be configured by editing touchcursor.vsprops.

Tools

Scripts that build the installer and docs require:

Building

Run build.bat to build executables and docs and package them into zip and installer files. Alternatively, load touchcursor.sln into Visual Studio and build in the IDE to build the executables only.

If your Visual Studio installation is not at the location used in the batch file, you'll need to edit it.

Project Directories

touchcursor Source for touchcursor.exe, which loads the hook DLL and runs the systray menu.

touchcursordll Source for touchcursor.dll. This is the core of TouchCursor and contains the keyboard hook function. (Windows requires this to be in a DLL rather than an exe.)

tcconfig Source for tcconfig.exe, which edits the configuration file. This was implemented as separate program to keep the memory usage of the permanently running modules low.

touchcursor_update Source for a touchcursor_update.exe, which is optionally used to check for a new version of TouchCursor. The separate exe is partly due to paranoia about malware scanners that might be suspicious of a program that installed a keyboard hook and connected to the internet.

tclib Functions shared by the other projects.

setup Source, scripts and dependencies for building the installer.

docs Source for the help file. The text is in Markdown format. The html is built by a script in the setup directory.

License & Copyright

Copyright © 2010 Martin Stone.

TouchCursor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

TouchCursor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with TouchCursor (COPYING.txt). If not, see http://www.gnu.org/licenses/.