diff --git a/README b/README new file mode 100644 index 0000000..10474b5 --- /dev/null +++ b/README @@ -0,0 +1,28 @@ +Switcher is a an entry to 6AMES MADE QUICK???, a game jam set during AGDQ 2022. + +Switcher is developed for the Sortix platform, and requires features from the +staging branch / volatile builds. It targets the current staging APIs as of +2022-10-16. + +Controls +-------- +Left arrow key - left +Right arrow key - right +Space - jump +R - rebind controls + +Building +-------- +Switcher can be built and installed either with make directly: + + make && make install + +or with tix-build (executed from the parent directory): + + tix-build switcher/ && tix-install switcher.tix.tar.xz + +Self-made levels +---------------- +If switcher is launched with a single command line argument, it tries to load a +level bundle from the specified file. See the file example-bundle.txt for +format.