Installing the SDK

The Qi repo contains various tools to aid in the development process, including command line scripts for performance benchmarking, and generating local test coverage reports in HTML format. In order to be able to use these tools seamlessly, they are included in a separate qi-sdk Racket package, as that allows it to be installed using Raco which would take care of installing all the necessary dependencies. Note that as these tools are not useful outside of Qi development, the SDK package is not listed on the Racket Package Index.

Install the SDK

make install-sdk

Once the SDK is installed, you will be able to run profilers (see Perf Loop) via e.g. make profile.

Note: at the moment, installing the SDK slows down normal development targets like make build since, for some reason, even though only the qi-lib package is indicated in that target, Raco still ends up building all Qi-related packages. For now, a workaround is to uninstall the SDK after installing it, via make remove-sdk, and that should work fine. The reason is that the purpose of the SDK is simply to install the necessary dependencies, and the actual Racket modules contained in it can just be run directly -- which is what the Makefile does. So, the SDK itself doesn't need to remain installed after it has been installed the first time. In the future, this issue should be investigated and fixed.