abouttreesummaryrefslogcommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJules Aguillon2022-04-24 20:52:36 +0200
committerJules Aguillon2022-04-24 20:52:36 +0200
commit39952f8bdf2ee77e32152bf67df456a83e3e03fe (patch)
tree0287109a42d37cb41e55aa456382df7184b513e3 /CONTRIBUTING.md
parentab4c73f9f3dda374e0ff60f2eab382612093263e (diff)
downloadunexpected-keyboard-39952f8bdf2ee77e32152bf67df456a83e3e03fe.tar.gz
unexpected-keyboard-39952f8bdf2ee77e32152bf67df456a83e3e03fe.zip
Remove build dependency on Fontforge
The required version of fontforge (from 2020!) is not available in many distros. This is an annoying for contributors and greatly complicated the CI and F-Droid scripts. The generated font file is now included in the sources. Fontforge is still needed when adding new glyphs but this is not a common operation.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 3 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bc4b288..4a107b1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,9 +11,9 @@ Fortunately, there's not many dependencies:
- OpenJDK 8
- Android SDK: build tools (minimum `28.0.1`), platform `30`
- Make sure to have the `$ANDROID_HOME` environment variable set.
-- FontForge version >= 20201107
-For Nix users, there's a `shell.nix` for setting-up the right environment.
+For Nix users, the right environment can be obtained with `nix-shell ./shell.nix`.
+Instructions to install Nix are [here](https://nixos.wiki/wiki/Nix_Installation_Guide).
Building the debug apk:
@@ -21,11 +21,7 @@ Building the debug apk:
make
```
-If the build succeed, the debug apk is located in
-`_build/juloo.keyboard2.debug.apk`.
-
-If the build doesn't succeeded check the FontForge version, the version needed is 20201107.
-Try to use the nix-shell, instructions to install [here](https://nixos.wiki/wiki/Nix_Installation_Guide)
+If the build succeed, the debug apk is located in `_build/juloo.keyboard2.debug.apk`.
## Using the local debug.keystore on the Github CI actions