tall, condensed bitmap font for geeks

reformat readme, add detailed install instructions

Akshay 86afd610 edeb62c3

+3
.gitignore
··· 5 5 *.otb 6 6 *.bdf 7 7 *.ttf 8 + 9 + # ttf converter binary 10 + BitsNPicas.jar
+76
INSTALL.md
··· 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!
+41 -131
README.md
··· 1 - # Scientifica 2 - 3 - ![deets.png](./img/sci0.png) 4 - 5 - Tall and condensed bitmap font for geeks. 6 - 7 - Scientifica is largely based on [creep](https://github.com/romeovs/creep), with a number 8 - of minor tweaks to improve readablity (*a matter of taste of course*). 9 - 10 - Most characters are just 4px wide, which is brilliant for low dpi(90-120) displays. 11 - 12 - 13 - ## What's different? 14 - 15 - 16 - Scientifica has a **bold** and an **italic** variant. 17 - 18 - Here are a few characters that recieved a revamp: 19 - 20 - `V, *, f, W, M, ~, & , i, t, a, (), [], {}` 21 - 22 - I have also added characters to the following unicode blocks: 23 - 24 - - Geometric Shapes 25 - - Arrows 26 - - Miscellaneous Technical 27 - - Miscellaneous Symbols 28 - - Miscellaneous Mathematical Symbols-A 29 - - Private Use Area 30 - - Mathematical Operators 31 - - Box Drawings 32 - 33 - I will be constantly adding glyphs to this font. **Keep a lookout.** 34 - 35 - 36 - 37 - ## Screenshots 38 - 39 - ### Dark background 40 - 41 - Scientifica in the wild: 42 - 43 - ![preview.png](./img/sci4.png) 1 + <p align="center"> 2 + <img src="img/sci0.png" alt="heroimage"> 3 + </p> 44 4 45 5 46 - Scientifica now has most box drawing glyphs as well! 6 + # scientifica 47 7 48 - ![tree.png](./img/sci2.png) 8 + > Tall and condensed bitmap font for geeks. 49 9 10 + `scientifica` is largely based on 11 + [`creep`](https://github.com/romeovs/creep), with a number of 12 + minor tweaks to improve readability (*a matter of taste of 13 + course*). Most characters are just 4px wide, which is brilliant for 14 + low dpi(90-120) displays. 50 15 51 - Latin, Polish, Solvakian, French, German accents included! 52 16 53 - ![polski.png](./img/sci3.png) 17 + ## What's new? 54 18 55 - 56 - Powerline glyphs 57 - 58 - ![powerline.png](./img/sci1.png) 59 - 60 - 61 - Unicode Python: 62 - 63 - ![scientificapyligs.png](https://0x0.st/scvt.png) 64 - 65 - 66 - Unicode C++ (Ligatures included) 67 - 68 - ![scientificaligs.png](https://0x0.st/scv4.png) 69 - 70 - 71 - *Please read [this](./ligature_plugins/README.md) for instructions on ligatures.* 19 + - Scaleable `ttf` format 20 + - Raster formats: `otb` and `bdf` 21 + - **Bold** and *Italic* variants 22 + - New Characters to the following unicode blocks: 23 + * Geometric Shapes 24 + * Arrows 25 + * Miscellaneous Technical 26 + * Miscellaneous Symbols 27 + * Miscellaneous Mathematical Symbols-A 28 + * Private Use Area (Powerline symbols) 29 + * Mathematical Operators 30 + * Box Drawings 72 31 73 - ### Light background 32 + - Revamped characters: `V, *, f, W, M, ~, & , i, t, a, (), [], {}` 74 33 34 + ## Gallery 75 35 76 - You're kidding me right? 36 + | ![sample image](./img/sci4.png) | ![sample image](./img/sci2.png) | ![sample image](./img/sci3.png) | ![sample image](./img/sci1.png) | 37 + | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | 38 + | Programming | Box Drawings | Latin, Polish, Slovakian, French, German | Powerline glyphs | 77 39 78 40 79 41 ## Installation 80 42 81 - 82 - ### Linux 83 - 84 - 85 - 1. Enable bitmap fonts 86 - ```shell 87 - cd /etc/fonts/conf.d/ 88 - sudo rm /etc/fonts/conf.d/10* && sudo rm -rf 70-no-bitmaps.conf && sudo ln -s ../conf.avail/70-yes-bitmaps.conf 89 - sudo dpkg-reconfigure fontconfig 90 - ``` 91 - 92 - 2. Get Scientifica 93 - ```shell 94 - cd ~ 95 - git clone https://github.com/nerdypepper/scientifica --depth 1 96 - ``` 97 - 98 - 3. Symlink it to the right folder 99 - ```shell 100 - ln -fs ~/scientifica/regular/scientifica-11.bdf ~/.local/share/fonts/scientifica-11.bdf 101 - ln -fs ~/scientifica/bold/scientificaBold-11.bdf ~/.local/share/fonts/scientificaBold-11.bdf 102 - ``` 103 - 104 - 4. Use it. `rxvt` for example: 105 - 106 - ``` ini 107 - URxvt.font:xft:scientifica:size=11 108 - URxvt.font:xft:scientifica:size=22 !for the doubled variant 109 - ``` 110 - 111 - 112 - ### MacOS 113 - 114 - 115 - 1. Get Scientifica 116 - ```shell 117 - cd ~ 118 - git clone https://github.com/nerdypepper/scientifica --depth 1 119 - ``` 120 - 121 - 2. Open the `.dfont` in the Font Book.app 122 - (This may not always be up to date. Try downloading the `.bdf` and exporting it to `.dfont` through fontforge) 123 - 124 - 3. You are done, I guess ... dont have a Mac to test it out. 125 - 126 - 4. Submit an issue in case you face any problems, or a pull request if you would like to correct me. 127 - 128 - 129 - 130 - ## TODO 131 - 132 - Following agenda *may* be followed: 133 - 134 - - Add Control Pictures 135 - - ~~Add all mathematical operators~~ (Almost) Done! 136 - - ~~Get scientifica to work on windows~~ Done! 137 - - ~~Work on a bold version (Probably never)~~ Done! 138 - - Add variants for `a, i, l, 1` etc. 43 + Installation instructions have been moved to 44 + [`INSTALL.md`](INSTALL.md) 139 45 140 46 141 47 142 48 ## Credits 143 49 144 - Most Basic Latin characters are from [creep](https://github.com/romeovs/creep) by [romeovs](https://github.com/romeovs/). 145 - 146 - 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). 147 - 148 - Some characters are based on [Lemon](http://artwizaleczapka.sourceforge.net/). 149 - 150 - Thanks to the creators of [Font Forge](https://fontforge.github.io/en-US/) for, well, creating fontforge. 50 + Most Basic Latin characters are from 51 + [creep](https://github.com/romeovs/creep) by 52 + [romeovs](https://github.com/romeovs/). 53 + Creep has been optimized for linux terminals by 54 + [raymond-w-ko](https://github.com/raymond-w-ko/). Check out 55 + his version [here](https://github.com/raymond-w-ko/creep2). 56 + Some characters are based on 57 + [Lemon](http://artwizaleczapka.sourceforge.net/). 58 + Thanks to the creators of [Font 59 + Forge](https://fontforge.github.io/en-US/) for, well, 60 + creating fontforge.
-3
ligature_plugins/README.md
··· 23 23 done 24 24 ``` 25 25 26 - Haskell in vim with scientifica: 27 - ![haskell_ligs](https://0x0.st/sT8a.png) 28 - 29 26 Credits go to [romeovs](https://github.com/romeovs/) for the haskell plugin. 30 27 Credits go to [ehamberg](https://github.com/ehamberg/vim-cute-python) for the python plugin. 31 28
ttf/scientifica.ttf

This is a binary file and will not be displayed.

ttf/scientificaBold.ttf

This is a binary file and will not be displayed.

ttf/scientificaItalic.ttf

This is a binary file and will not be displayed.