Colemak Camp

A fork of Colemak Club that overhauls the entire experience. Brings support for custom themes and a wider range of display sizes.

It is hosted on this repo's Github Pages.

Note that this project is a fork of Colemak Club, which itself is a fork of Colemak Academy.

Key Features

The following features are new in Colemak Camp:

• Responsive design, fits in more display sizes.
• Customizable theme colors, including light and dark modes.
• Several more menu options are now saved in local storage, thus remembered if you refresh.
• Cheatsheet keyboard is sized more accurately.
• Custom input keyboard changes according to selected keyboard type.
• Overall change in the design language.
• Persistent custom layout via local storage.
• Support for phones and tablets running Android (and iOS hopefully).

Planned Features

• Custom themes.
• Sharing and loading custom themes via links.

Build Tools

This project does not rely on npm or other similar tools. You may utilize any toolchain you want as long as you can reproduce same results.

• Install VS Code
• Install extensions:
  • Nu-Minify
  • Live Sass Compiler
  • Live Server
• Update VS Code settings:

{
    "minify.js": {
        "output": {
            "comments": "/^!/"
        }
    },
    "minify.minifyExistingOnSave": true,
    "liveSassCompile.settings.useNewCompiler": true,
    "liveServer.settings.donotShowInfoMsg": true
}

• Watch Sass
  • You will need to click 'Watch Sass' to compile scss files to css. Once clicked, all changes will be automatically compiled within that session. Note that this does not minify anything.
• Minify on Save
  • Using the settings above will enable this feature; otherwise enable it manually from extension settings.
  • If the file you're minifying already has an existing .min file, simply saving the source will update the minified file. So, you need to save the main.css file to update the main.min.css file.
  • If there is no existing .min file, run the Minify command on the source file. (Press F1 to search available commands, >minify.)

Pull Requests

Please create an issue and await my response before submitting any pull requests.

License

This project is under the GNU Affero General Public License v3.0 (AGPL-3.0), which is the same as Colemak Club and Colemak Academy, as seen in this issue.

Parts of the project that are not a part of this license are mentioned in this table:

Project Name	Project License
Popper	MIT
Tippy.js	MIT
Fork Awesome CSS	MIT
Cuprum (Google Fonts)	Open Font License
Radio Canada (Google Fonts)	Open Font License
Cascadia Code (Microsoft)	Open Font License
Material Icons (Google Fonts)	Apache-2.0

Icon Attributions

Some of the icons have been taken from Flaticon, which requires attribution. Below is a list of all the icons in the fontasm font file that are directly taken from Flaticon or modified based on something from Flaticon.

Icon Class	Attribution
fa-arrow-top	Flaticon
fa-arrow-right	Flaticon
fa-arrow-bottom	Flaticon
fa-arrow-left	Flaticon
fa-editor	Flaticon
fa-settings	Flaticon
fa-theme	Flaticon
fa-preferences	Flaticon
fa-send	Flaticon
fa-edit	Flaticon
fa-keyboard	Flaticon

Icons not listed here are either from Material Icons, or created from scratch.