diff --git a/linux/keyman-config/README.md b/linux/keyman-config/README.md index baf2905457..9081aa0399 100644 --- a/linux/keyman-config/README.md +++ b/linux/keyman-config/README.md @@ -3,17 +3,20 @@ ## Preparing to run If you are running from the repo or installing keyman-config manually rather than from a package -then you will need to +then you will need to: -`sudo apt install python3-lxml python3-magic python3-numpy python3-qrcode python3-pil python3-requests -python3-requests-cache python3 python3-gi gir1.2-webkit2-4.0 dconf-cli python3-setuptools` +```bash +sudo apt install python3-lxml python3-magic python3-numpy python3-qrcode python3-pil python3-requests \ + python3-requests-cache python3 python3-gi gir1.2-webkit2-4.0 dconf-cli python3-setuptools +``` -You will also need kmflcomp either from a package or built and installed locally. +You will also need `kmflcomp` either from a package or built and installed locally. Run the script `./createkeymandirs.sh` to create the directories for these programs to -install the packages to +install the packages to. + +Also copy and compile the GSettings schema: -Also copy and compile the GSettings schema ```bash cd keyman_config sudo cp com.keyman.gschema.xml /usr/share/glib-2.0/schemas @@ -22,8 +25,10 @@ sudo glib-compile-schemas /usr/share/glib-2.0/schemas ### Installing manually from the repo -`make && sudo make install` will install locally to /usr/local +`make && sudo make install` will install locally to `/usr/local` + `python3 setup.py --help install` will give you more install options + You will need `sudo apt install python3-pip` to `make uninstall` ## Things to run from the command line @@ -34,12 +39,13 @@ You will need `sudo apt install python3-pip` to `make uninstall` This displays a configuration panel that shows the currently installed Keyman keyboard packages and can download and install additional keyboards. -##### Buttons +#### Buttons * `Uninstall` - uninstall selected keyboard * `About` - show information about selected keyboard * `Help` - display help documentation about selected keyboard * `Options` - display options.htm form for setting keyboard options + ----------------------------------- * `Refresh` - useful if you install or uninstall on the commandline while running km-config. @@ -47,7 +53,7 @@ This displays a configuration panel that shows the currently installed Keyman ke * `Install` - opens a file choose dialog to choose a kmp file to install and bring up the `InstallKmpWindow` for more details and to confirm installing. * `Close` - close the configuration panel -##### Download window +#### Download window This uses the keyman.com website to install kmps. @@ -58,7 +64,6 @@ Click it to download the keyboard and bring up the `InstallKmpWindow` for more d Secondary-click gives you a menu including 'Back' to go back a page. - ### km-package-install `km-package-install -p ` install Keyman keyboard package from the keyman.com server @@ -87,8 +92,7 @@ Secondary-click gives you a menu including 'Back' to go back a page. ### km-kvk2ldml -`km-kvk2ldml [-p] [-k] [-o LDMLFILE] ` Convert a Keyman kvk on-screen keyboard file to an LDML file. Optionally print the details of the kvk file [-p] optionally with all keys [-k]. - +`km-kvk2ldml [-p] [-k] [-o LDMLFILE] ` Convert a Keyman kvk on-screen keyboard file to an LDML file. Optionally print the details of the kvk file (`-p`) optionally with all keys (`-k`). ## Building the Debian package @@ -96,4 +100,4 @@ You will need the build dependencies as well as the runtime dependencies above `sudo apt install dh-python python3-all debhelper help2man` -Run `make deb`. This will build the Debian package in the make_deb directory. +Run `make deb`. This will build the Debian package in the `make_deb` directory.