erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-10-07 14:37:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

style(linux): Reformat Linux readme

Browse source
This commit is contained in:
Eberhard Beilharz 2020-06-17 18:05:24 +02:00
parent 6aa58653e3
commit 44425f0f89
No known key found for this signature in database
GPG key ID: 64A39A9E98B53105
1 changed files with 61 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

116
linux/README.md
View file

@ -2,13 +2,15 @@
## Projects
* [kmflcomp](./kmflcomp) - KMFL keyboard compiler
* [libkmfl](./libkmfl) - core library
* [ibus-kmfl](./ibus-kmfl) - IBUS integration to use KMFL
* [ibus-keyman](./ibus-keyman) - IBUS integration to use .kmx Keyman keyboards
* scim\_kmfl\_imengine - deprecated SCIM engine to use KMFL
- [keyman-config](./keyman-config) - km-config and some other tools to install, uninstall
and view information about Keyman keyboard packages.
- [ibus-keyman](./ibus-keyman) - IBUS integration to use .kmx Keyman keyboards
- [kmflcomp](./kmflcomp) - KMFL keyboard compiler
- [libkmfl](./libkmfl) - older KMFL core library
- [ibus-kmfl](./ibus-kmfl) - IBUS integration to use KMFL
- scim\_kmfl\_imengine - deprecated SCIM engine to use KMFL
See [license information](./LICENSE.md) about licensing.
See [license information](./LICENSE.md) about licensing.
## Linux Requirements/Setup
@ -25,52 +27,57 @@
- The process to build and install everything is:
* `make reconf` to create the build system and set the version
* `make fullbuild` to configure and build
* `sudo make install` to install to /usr/local
- `make reconf` to create the build system and set the version
- `make fullbuild` to configure and build
- `sudo make install` to install to `/usr/local`
- Some of the files must be installed to `/usr/share/` so `make install` must be run as `sudo`.
- To do this run ` sudo make install`
To do this run `sudo make install`
* This will install to /usr/local
* and `/usr/share/ibus/component/kmfl.xml` and `/usr/share/kmfl/icons`
* and `/usr/share/ibus/component/keyman.xml` and `/usr/share/keyman/icons`
- This will install to `/usr/local`
- and `/usr/share/ibus/component/kmfl.xml` and `/usr/share/kmfl/icons`
- and `/usr/share/ibus/component/keyman.xml` and `/usr/share/keyman/icons`
* If you already have the ibus-kmfl package installed then it will move the file `/usr/share/ibus/component/kmfl.xml` to `/usr/share/doc/ibus-kmfl/`
* If you already have the ibus-keyman package installed then it will move the file `/usr/share/ibus/component/keyman.xml` to `/usr/share/doc/ibus-keyman/`
- If you already have the ibus-kmfl package installed then it will move the file `/usr/share/ibus/component/kmfl.xml` to `/usr/share/doc/ibus-kmfl/`
- If you already have the ibus-keyman package installed then it will move the file `/usr/share/ibus/component/keyman.xml` to `/usr/share/doc/ibus-keyman/`
* run `sudo make uninstall` to uninstall everything and put it back again
- run `sudo make uninstall` to uninstall everything and put it back again
##### Tmp install
Used by TC for validating PRs
Run `make tmpinstall` to build and install keyboardprocessor, kmflcomp, libkmfl, ibus-kmfl and ibus-keyman to `/tmp/kmfl`
Run `make tmpinstall` to build and install **keyboardprocessor**, **kmflcomp**, **libkmfl**, **ibus-kmfl** and **ibus-keyman** to `/tmp/kmfl`
This is only for testing the build, not for running ibus-kmfl or ibus-keyman in ibus
This is only for testing the build, not for running **ibus-kmfl** or **ibus-keyman** in ibus
#### Manually
* libkmfl requires kmfl.h header from kmflcomp
* ibus-kfml requires kmfl.h and headers and lib from libkmfl
* ibus-keyman requires headers and lib from keyboardprocessor
- **libkmfl** requires `kmfl.h` header from **kmflcomp**
- **ibus-kfml** requires `kmfl.h` and headers and lib from **libkmfl**
- **ibus-keyman** requires headers and lib from **keyboardprocessor**
So
* kmflcomp must be built and installed before libkmfl
* libkmfl must be built and installed before ibus-kmfl
* keyboardprocessor must be built before ibus-keyman
So
For each project run `./configure && make && make install`.
- **kmflcomp** must be built and installed before **libkmfl**
- **libkmfl** must be built and installed before **ibus-kmfl**
- **keyboardprocessor** must be built before **ibus-keyman**
You may prefer to create a different directory to build in and run configure from there e.g.
For each project run `./configure && make && make install`.
`mkdir ../build-kmflcomp;`
`cd ../build-kmflcomp`
`../kmflcomp/configure`
`make `
`make install`
You may prefer to create a different directory to build in and run configure from there e.g.
The install of ibus-kmfl doesn't install everything to the correct location for it to be used - to be fixed
```bash
mkdir ../build-kmflcomp
cd ../build-kmflcomp
../kmflcomp/configure
make
make install
```
The install of **ibus-kmfl** doesn't install everything to the correct location for it to be
used - to be fixed
### Continuous integration
@ -93,7 +100,7 @@ Tests to be created as there are no current tests
Ibus should be running on a default install of Ubuntu
You may want to install extra packages to get other ibus input methods e.g ibus-unikey for VN
You may want to install extra packages to get other ibus input methods e.g **ibus-unikey** for VN
Run `ibus restart` after installing any of them
@ -105,19 +112,19 @@ Run `ibus restart` after installing any of them
##### GNOME3 (focal and bionic default)
* Click the connection/sound/shutdown section in the top right. Then the tools icon for Settings.
- Click the connection/sound/shutdown section in the top right. Then the tools icon for Settings.
* In `Language and Region` click `+` to add a keyboard.
* Click the 3 dots expander then search for "Other" and click it
* The Keyman keyboards should be listed here to choose
- In `Language and Region` click `+` to add a keyboard.
- Click the 3 dots expander then search for "Other" and click it
- The Keyman keyboards should be listed here to choose
* Use `Win-space` to switch between keyboards.
- Use `Win-space` to switch between keyboards.
##### Unity (xenial default)
* Run `Text Entry`
* Click `+` to add a keyboard.
* In `Choose an input source` search for "Other" or the keyboard name, or "Ibus" to find Keyman keyboards.
- Run `Text Entry`
- Click `+` to add a keyboard.
- In `Choose an input source` search for "Other" or the keyboard name, or "Ibus" to find Keyman keyboards.
Check `Show current input source in the menu bar` to see what keyboard you are using and have a menu for keyboards.
@ -125,19 +132,18 @@ Use `Win-space` to switch between keyboards.
##### Cinnamon (wasta xenial default)
* Open `Menu` and find `IBus Preferences`and run it
* Make sure `Show icon on system tray` is checked
* Select the tab `Input Method`.
* Click `Add` to add a keyman keyboard.
* Click the 3 dots expander then search for "Other" and click it
* The Keyman keyboards should be listed here to choose
- Open `Menu` and find `IBus Preferences`and run it
- Make sure `Show icon on system tray` is checked
- Select the tab `Input Method`.
- Click `Add` to add a keyman keyboard.
- Click the 3 dots expander then search for "Other" and click it
- The Keyman keyboards should be listed here to choose
##### MATE (alternative)
* Open `System-> Preferences -> Other -> IBus Preferences`.
* Make sure `Show icon on system tray` is checked
* Select the tab `Input Method`.
* Click `Add` to add a keyman keyboard.
* Click the 3 dots expander then search for "Other" and click it
* The Keyman keyboards should be listed here to choose
- Open `System-> Preferences -> Other -> IBus Preferences`.
- Make sure `Show icon on system tray` is checked
- Select the tab `Input Method`.
- Click `Add` to add a keyman keyboard.
- Click the 3 dots expander then search for "Other" and click it
- The Keyman keyboards should be listed here to choose