This will compile the engine, but not all the dictionaries etc for the javelin firmware.
As such, you first need to flash a firmware from the (closed source) firmware builder at https://lim.au/. This will include the engine for whichever board you choose (I've been using the starboard). Then you get the .uf2 from this project and flash it over the top, and hopefully the whole thing works.
The firmware builder has a lot of options that can't be controlled from script, so here's my notes from the last time I did it:
- Select your hardware: Starboard
- Show expert options
- Simple [x] Advanced
- Upload the 3 yaml files from this project (
uk_{ibus,win_alt,win_hex}.yaml
). - Keyboard Protocol: default
-
Space Position: Before
-
don't enable first up or repeat
-
Check All the built in ones
-
Upload the dictionaries from https://github.com/tocklime/plover_dictionaries :
- jeff-numbers
- jeff-show-stroke
- user.json - be sure to promote anything in the onboard ram of the to-be-overwritten firmware.
- jeff-phrasing
- abby-left-hand-modifiers.json
- emily-modifiers.json
- emily-symbols
- warbler-base.json
- lapwing-javelin-additions.json
- lapwing-semi-modal-movements.json
- lapwing-commands.json
- lapwing-numbers.json
- lapwing-uk-additions.json
- lapwing-proper-nouns.json
- lapwing-base.json
-
Generate reverse lookup tables
Load layout-script.javelin-script
from this directory.
Use american_english_words.txt
and english-orthography.json
from this dir.