diff options
Diffstat (limited to 'INSTALL.md')
-rw-r--r-- | INSTALL.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..0296738 --- /dev/null +++ b/INSTALL.md | |||
@@ -0,0 +1,76 @@ | |||
1 | # Installation | ||
2 | |||
3 | - [Install from release](#install-from-release) | ||
4 | - [Build from source](#build-from-source) | ||
5 | - [Verification](#verification) | ||
6 | - [Troubleshooting](#troubleshooting) | ||
7 | |||
8 | ## Install from release | ||
9 | |||
10 | 1. Grab the latest release from the | ||
11 | [releases](https://github.com/NerdyPepper/scientifica/releases) | ||
12 | page. | ||
13 | |||
14 | 2. Extract the release package: | ||
15 | ```shell | ||
16 | tar xzf scientifica-v1.2.tar.gz | ||
17 | ``` | ||
18 | |||
19 | 3. You may install either the `ttf`s or the `otb`s or the | ||
20 | `bdf`s | ||
21 | ```shell | ||
22 | # ttfs are recommended | ||
23 | cp ttf/* ~/.local/share/fonts/ | ||
24 | |||
25 | # but you may install the otbs if you want to | ||
26 | cp otb/* ~/.local/share/fonts | ||
27 | |||
28 | # bdfs are not recommendedk | ||
29 | cp bdf/* ~/.local/share/fonts | ||
30 | ``` | ||
31 | |||
32 | ## Build from source | ||
33 | |||
34 | Requirements: | ||
35 | |||
36 | - java | ||
37 | - [BitsNPicas](https://github.com/kreativekorp/bitsnpicas) | ||
38 | - [fontforge](https://fontforge.org) | ||
39 | - python3 | ||
40 | |||
41 | On Debian based distros, you can install all requirements | ||
42 | via: | ||
43 | ``` | ||
44 | sudo apt install openjdk-8-jdk openjdk-8-jre python3 fontforge | ||
45 | curl -o BitsNPicas.jar "https://github.com/kreativekorp/bitsnpicas/blob/master/downloads/BitsNPicas.jar" | ||
46 | ``` | ||
47 | |||
48 | 1. Open `build.sh` and change variable `BNP` to the full | ||
49 | path to the BitsNPicas `jar` file. | ||
50 | ```shell | ||
51 | # for example.: | ||
52 | export BNP="/home/nerdypepper/downloads/BitsNPicas.jar" | ||
53 | ``` | ||
54 | |||
55 | 2. Run `build.sh` | ||
56 | 3. If everything went well, you will find the generated font | ||
57 | files under the `build` folder. | ||
58 | 4. Continue with step 3 of "Install from release" | ||
59 | |||
60 | ## Verification | ||
61 | |||
62 | Check if your installation procedure was a success: | ||
63 | |||
64 | 1. Run `fc-list | grep sci` | ||
65 | 2. If the output is **not** null, congrats! | ||
66 | 3. Proceed to [Troubleshooting](#troubleshooting) if the output is empty | ||
67 | |||
68 | ## Troubleshooting | ||
69 | |||
70 | If your application does not recognize the font, you can | ||
71 | try a couple of things: | ||
72 | |||
73 | - use `ttf` variant instead of the `otb` or `bdf` | ||
74 | variants | ||
75 | - run `fc-cache --really-force -v` and verify again | ||
76 | - open an issue, I'd love to help you out! | ||