From 86afd610e79505d0fbc67ff55ae78a6873242cc3 Mon Sep 17 00:00:00 2001 From: Akshay Date: Mon, 13 Apr 2020 16:14:35 +0530 Subject: reformat readme, add detailed install instructions --- .gitignore | 3 + INSTALL.md | 76 ++++++++++++++++++++ README.md | 172 +++++++++++---------------------------------- ligature_plugins/README.md | 3 - ttf/scientifica.ttf | Bin 119260 -> 0 bytes ttf/scientificaBold.ttf | Bin 107384 -> 0 bytes ttf/scientificaItalic.ttf | Bin 121932 -> 0 bytes 7 files changed, 120 insertions(+), 134 deletions(-) create mode 100644 INSTALL.md delete mode 100644 ttf/scientifica.ttf delete mode 100644 ttf/scientificaBold.ttf delete mode 100644 ttf/scientificaItalic.ttf diff --git a/.gitignore b/.gitignore index 49dc5f9..908d06d 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,6 @@ build/ *.otb *.bdf *.ttf + +# ttf converter binary +BitsNPicas.jar diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..0296738 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,76 @@ +# Installation + + - [Install from release](#install-from-release) + - [Build from source](#build-from-source) + - [Verification](#verification) + - [Troubleshooting](#troubleshooting) + +## Install from release + + 1. Grab the latest release from the +[releases](https://github.com/NerdyPepper/scientifica/releases) +page. + + 2. Extract the release package: +```shell +tar xzf scientifica-v1.2.tar.gz +``` + +3. You may install either the `ttf`s or the `otb`s or the +`bdf`s +```shell +# ttfs are recommended +cp ttf/* ~/.local/share/fonts/ + +# but you may install the otbs if you want to +cp otb/* ~/.local/share/fonts + +# bdfs are not recommendedk +cp bdf/* ~/.local/share/fonts +``` + +## Build from source + +Requirements: + + - java + - [BitsNPicas](https://github.com/kreativekorp/bitsnpicas) + - [fontforge](https://fontforge.org) + - python3 + +On Debian based distros, you can install all requirements +via: +``` +sudo apt install openjdk-8-jdk openjdk-8-jre python3 fontforge +curl -o BitsNPicas.jar "https://github.com/kreativekorp/bitsnpicas/blob/master/downloads/BitsNPicas.jar" +``` + +1. Open `build.sh` and change variable `BNP` to the full + path to the BitsNPicas `jar` file. +```shell +# for example.: +export BNP="/home/nerdypepper/downloads/BitsNPicas.jar" +``` + +2. Run `build.sh` +3. If everything went well, you will find the generated font + files under the `build` folder. +4. Continue with step 3 of "Install from release" + +## Verification + +Check if your installation procedure was a success: + + 1. Run `fc-list | grep sci` + 2. If the output is **not** null, congrats! + 3. Proceed to [Troubleshooting](#troubleshooting) if the output is empty + +## Troubleshooting + + If your application does not recognize the font, you can +try a couple of things: + + - use `ttf` variant instead of the `otb` or `bdf` + variants + - run `fc-cache --really-force -v` and verify again + - open an issue, I'd love to help you out! diff --git a/README.md b/README.md index c5b3fe9..9f1bc77 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,60 @@ -# Scientifica +

+ heroimage +

-![deets.png](./img/sci0.png) -Tall and condensed bitmap font for geeks. +# scientifica -Scientifica is largely based on [creep](https://github.com/romeovs/creep), with a number -of minor tweaks to improve readablity (*a matter of taste of course*). +> Tall and condensed bitmap font for geeks. -Most characters are just 4px wide, which is brilliant for low dpi(90-120) displays. +`scientifica` is largely based on +[`creep`](https://github.com/romeovs/creep), with a number of +minor tweaks to improve readability (*a matter of taste of +course*). Most characters are just 4px wide, which is brilliant for +low dpi(90-120) displays. -## What's different? +## What's new? + - Scaleable `ttf` format + - Raster formats: `otb` and `bdf` + - **Bold** and *Italic* variants + - New Characters to the following unicode blocks: + * Geometric Shapes + * Arrows + * Miscellaneous Technical + * Miscellaneous Symbols + * Miscellaneous Mathematical Symbols-A + * Private Use Area (Powerline symbols) + * Mathematical Operators + * Box Drawings -Scientifica has a **bold** and an **italic** variant. + - Revamped characters: `V, *, f, W, M, ~, & , i, t, a, (), [], {}` -Here are a few characters that recieved a revamp: +## Gallery -`V, *, f, W, M, ~, & , i, t, a, (), [], {}` - -I have also added characters to the following unicode blocks: - - - Geometric Shapes - - Arrows - - Miscellaneous Technical - - Miscellaneous Symbols - - Miscellaneous Mathematical Symbols-A - - Private Use Area - - Mathematical Operators - - Box Drawings - -I will be constantly adding glyphs to this font. **Keep a lookout.** - - - -## Screenshots - -### Dark background - -Scientifica in the wild: - -![preview.png](./img/sci4.png) - - -Scientifica now has most box drawing glyphs as well! - -![tree.png](./img/sci2.png) - - -Latin, Polish, Solvakian, French, German accents included! - -![polski.png](./img/sci3.png) - - -Powerline glyphs - -![powerline.png](./img/sci1.png) - - -Unicode Python: - -![scientificapyligs.png](https://0x0.st/scvt.png) - - -Unicode C++ (Ligatures included) - -![scientificaligs.png](https://0x0.st/scv4.png) - - -*Please read [this](./ligature_plugins/README.md) for instructions on ligatures.* - -### Light background - - -You're kidding me right? +| ![sample image](./img/sci4.png) | ![sample image](./img/sci2.png) | ![sample image](./img/sci3.png) | ![sample image](./img/sci1.png) | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| Programming | Box Drawings | Latin, Polish, Slovakian, French, German | Powerline glyphs | ## Installation - -### Linux - - - 1. Enable bitmap fonts - ```shell - cd /etc/fonts/conf.d/ - sudo rm /etc/fonts/conf.d/10* && sudo rm -rf 70-no-bitmaps.conf && sudo ln -s ../conf.avail/70-yes-bitmaps.conf - sudo dpkg-reconfigure fontconfig - ``` - - 2. Get Scientifica - ```shell - cd ~ - git clone https://github.com/nerdypepper/scientifica --depth 1 - ``` - - 3. Symlink it to the right folder - ```shell -ln -fs ~/scientifica/regular/scientifica-11.bdf ~/.local/share/fonts/scientifica-11.bdf -ln -fs ~/scientifica/bold/scientificaBold-11.bdf ~/.local/share/fonts/scientificaBold-11.bdf - ``` - - 4. Use it. `rxvt` for example: - - ``` ini -URxvt.font:xft:scientifica:size=11 -URxvt.font:xft:scientifica:size=22 !for the doubled variant - ``` - - -### MacOS - - - 1. Get Scientifica - ```shell - cd ~ - git clone https://github.com/nerdypepper/scientifica --depth 1 - ``` - - 2. Open the `.dfont` in the Font Book.app -(This may not always be up to date. Try downloading the `.bdf` and exporting it to `.dfont` through fontforge) - - 3. You are done, I guess ... dont have a Mac to test it out. - - 4. Submit an issue in case you face any problems, or a pull request if you would like to correct me. - - - -## TODO - -Following agenda *may* be followed: - - - Add Control Pictures - - ~~Add all mathematical operators~~ (Almost) Done! - - ~~Get scientifica to work on windows~~ Done! - - ~~Work on a bold version (Probably never)~~ Done! - - Add variants for `a, i, l, 1` etc. +Installation instructions have been moved to +[`INSTALL.md`](INSTALL.md) ## Credits -Most Basic Latin characters are from [creep](https://github.com/romeovs/creep) by [romeovs](https://github.com/romeovs/). - -Creep has been optimized for linux terminals by [raymond-w-ko](https://github.com/raymond-w-ko/). Check out his version [here](https://github.com/raymond-w-ko/creep2). - -Some characters are based on [Lemon](http://artwizaleczapka.sourceforge.net/). - -Thanks to the creators of [Font Forge](https://fontforge.github.io/en-US/) for, well, creating fontforge. +Most Basic Latin characters are from +[creep](https://github.com/romeovs/creep) by +[romeovs](https://github.com/romeovs/). +Creep has been optimized for linux terminals by +[raymond-w-ko](https://github.com/raymond-w-ko/). Check out +his version [here](https://github.com/raymond-w-ko/creep2). +Some characters are based on +[Lemon](http://artwizaleczapka.sourceforge.net/). +Thanks to the creators of [Font +Forge](https://fontforge.github.io/en-US/) for, well, +creating fontforge. diff --git a/ligature_plugins/README.md b/ligature_plugins/README.md index 954ef6a..59beda8 100644 --- a/ligature_plugins/README.md +++ b/ligature_plugins/README.md @@ -23,9 +23,6 @@ Symlink the required vim plugins to done ``` -Haskell in vim with scientifica: -![haskell_ligs](https://0x0.st/sT8a.png) - Credits go to [romeovs](https://github.com/romeovs/) for the haskell plugin. Credits go to [ehamberg](https://github.com/ehamberg/vim-cute-python) for the python plugin. diff --git a/ttf/scientifica.ttf b/ttf/scientifica.ttf deleted file mode 100644 index 7d80a2b..0000000 Binary files a/ttf/scientifica.ttf and /dev/null differ diff --git a/ttf/scientificaBold.ttf b/ttf/scientificaBold.ttf deleted file mode 100644 index a4121e1..0000000 Binary files a/ttf/scientificaBold.ttf and /dev/null differ diff --git a/ttf/scientificaItalic.ttf b/ttf/scientificaItalic.ttf deleted file mode 100644 index 904809d..0000000 Binary files a/ttf/scientificaItalic.ttf and /dev/null differ -- cgit v1.2.3