Skip to content

Commit

Permalink
Update readme images
Browse files Browse the repository at this point in the history
  • Loading branch information
mishamyrt committed Apr 12, 2023
1 parent cdd0929 commit 6d95e11
Show file tree
Hide file tree
Showing 13 changed files with 66 additions and 34 deletions.
100 changes: 66 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,106 @@
<p align="center">
<img
src="./showcases/logo@2x.png"
alt="Lilex logo"
width="464px">
src="./images/main@2x.png"
alt="Lilex. The font for developers."
width="362px">
<p>

[![Build](https://github.com/mishamyrt/Lilex/actions/workflows/build.yaml/badge.svg)](https://github.com/mishamyrt/Lilex/actions/workflows/build.yaml)

Lilex is the modern programming font containing a set of ligatures for common programming multi-character combinations.

This is just a font rendering feature: underlying code remains ASCII-compatible. This helps to read and understand code faster. For some frequent sequences like `..` or `//`, ligatures allow us to correct spacing like kerning pairs.
This is just a font rendering feature: underlying code remains ASCII-compatible. This makes it easier to read and understand the code. In some cases, the ligatures connect closely related characters (`==`, `---`), while in others they optically align the glyphs (`..`, `??`).

Compiled versions are available under [releases](https://github.com/mishamyrt/Lilex/releases). Bleeding edge builds can be downloaded in the [build](https://github.com/mishamyrt/Lilex/actions/workflows/build.yaml) workflow artifacts.

## Installation

1. [Download font](https://github.com/mishamyrt/Lilex/releases/latest).
2. Unzip the archive and install the font:
* Mac: Select `Lilex-VF.ttf` in the `variable` folder and double-click it. Click the `Install Font` button.
* Windows: Select all font files in the `ttf` folder, right-click any of them, then pick `Install` from the menu.

### Visual Studio Code

1. From the `Code` menu (`File` on Windows) go to `Preferences``Settings`, or use keyboard shortcut <kbd>⌘</kbd>+<kbd>,</kbd> (<kbd>Ctrl</kbd>+<kbd>,</kbd> on Windows).
2. In the `Editor: Font Family` input box type `Lilex`.
3. To enable ligatures, go to `Editor: Font Ligatures`, click `Edit in settings.json`, and copy `"editor.fontLigatures": true` into file.

Compiled versions are available under [releases](https://github.com/mishamyrt/Lilex/releases).
### iTerm2
1. From the `iTerm2` menu go to `Settings`. Under `Profiles`, find the `Text` tab.
2. If you have more than one profile, select the one you want to change. Or change the default one (with an asterisk).
3. Click on the font name under the 'Font' heading, find `Lilex` and select it.

## Examples
> **Note** I recommend using ExtraThick instead of Regular for iTerm2, so the letter thickness will roughly match VS Code.
### JavaScript (JSX)
## Weight

<img src="./showcases/[email protected]">
There are 6 font weights available in Lilex, ranging from Thin to Bold. In addition, a variation font is available.

### PHP
<img src="./images/[email protected]">

<img src="./showcases/[email protected]">
## Character Set

### Go
The font has support for Latin, Cyrillic and Greek. It also includes ligatures and powerline symbols.

<img src="./showcases/go@2x.png">
<img src="./images/character-set@2x.png">

### C
A full glyph table can be found on the [preview page](https://mishamyrt.github.io/Lilex/).

<img src="./showcases/[email protected]">
## Features

## Stylistic sets
The font has additional styles for some characters, so it can be configured to better fit your needs. Instructions on how to activate OpenType features in your IDE can be found on the internet, or [build your own variation](#forced-feature-activation) of the font with forced features

Additional features are available in the font, which are disabled by default.
<img src="./images/[email protected]">

<img src="./showcases/[email protected]">
Some ligatures also have additional options. For example, certain arrows are initially switched off to avoid conflicts with logical operations.

## Setup
<img src="./images/[email protected]">

### Arrows

Lilex uses generated ligatures for arrows, so they can be infinite. Combine that to assemble your unique arrows.

There is also a full set of single-character arrows (``, ``, etc.) in the font.

<img src="./images/[email protected]">

## Build

At the moment building is possible on Ubuntu and macOS. First, install the build dependencies.
### Setup

### macOS
At the moment building is possible on Ubuntu and macOS. First, install the system dependencies.

#### macOS

```sh
brew install cairo freetype harfbuzz pkg-config
```

### Ubuntu
#### Ubuntu

```sh
sudo apt install python3-setuptools ttfautohint build-essential libffi-dev libgit2-dev
```

### Common
#### Common

Clone the repository and navigate to the project folder:

```
git clone https://github.com/mishamyrt/Lilex
cd Lilex
```

And then setup virtual environment:
And then setup python virtual environment:

```sh
make configure
```

## Build
### Compile

Now run the command to build it.
Now run the command to build Lilex.

```sh
make build
Expand All @@ -76,18 +114,12 @@ or

### Forced feature activation

The builder gives you the ability to forcibly enable any font features. This works by moving their code to the calt. If ligatures work, the selected features will also work.

To do this, regenerate the source file with the features:

```sh
./scripts/lilex.py --features 'sups,zero' generate -o Lilex.custom.glyphs
```
The builder gives you the ability to forcibly enable any font features. This works by moving their code to the calt. If the ligatures work, the selected features will also work.

And then build the binaries from the new source:
To do this, build the binaries from the source file with the features:

```sh
./scripts/lilex.py -i Lilex.custom.glyphs build
./scripts/lilex.py --features 'ss01,zero' build
```

## Credits
Expand Down
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed showcases/[email protected]
Binary file not shown.
Binary file removed showcases/[email protected]
Binary file not shown.
Binary file removed showcases/[email protected]
Binary file not shown.
Binary file removed showcases/[email protected]
Binary file not shown.
Binary file removed showcases/[email protected]
Binary file not shown.
Binary file removed showcases/[email protected]
Binary file not shown.

0 comments on commit 6d95e11

Please sign in to comment.