Skip to content

Latest commit

聽

History

History
142 lines (96 loc) 路 5.44 KB

INSTALL.md

File metadata and controls

142 lines (96 loc) 路 5.44 KB
Raw

Installation

Contents

Requirements

This app uses font symbols and Unicode characters. Since it runs in the terminal, it depends on the fonts available on the system and the terminal's font configuration. This is not a pre-installation requirement. If fonts appear to be missing, you can also install them after the app was installed.

On windows it is advised to use Windows Terminal instead of the standard terminal.

Fonts

A Nerd Font must be used as terminal font and a Unicode symbol font must be installed on the system.

Direct Download

To download font files directly and install them using your systems font installer, use the links below.

  1. A font that is patched to include Nerd icons (e.g. JetBrainsMono) - should be configured as terminal font
    JetBrainsMono.zip

  2. A font that adds Emoji and Unicode support - no config changes required
    NotoColorEmoji.ttf
    NotoSansSymbols2-Regular.ttf

toggle

Font download instructions with additional and platform-specific information

1. Nerd Font

A nerd font is usually a regular font that is patched to include additional glyphs. The usage is not bound to a single font. Every font that is patched to include nerd icons can work. This example uses the Nerd Font version of JetBrains Mono.

The nerd-fonts github repository and website make a number of patched fonts available and provide several installation options for different platforms.

Package manager installation examples are shown below.

  • On macOS, using brew

    brew tap homebrew/cask-fonts   # This is only required once
brew install font-jetbrains-mono-nerd-font  # Or any other nerd-font

  • On Windows, using choco

    choco install nerd-fonts-jetbrainsmono

  • On Linux, many distribution make fonts available via their package manager.

    E.g., search for the JetBrains Nerd Font on Manjaro using paru

    paru jetbrains nerd

After installing the font, make sure to update your terminals font configuration!

2. Unicode symbol font

A Unicode symbol font("emoji-font") needs to be available on the system. It is likely already installed if you see emojis correctly rendered in your browser and in other applications. It will also allow to display Unicode line characters that are used in wthrrs daily weather graphs. Noto fonts provide support for symbol and emoji fonts and are usually available via the package manager.

  • macOS

    brew install font-noto-sans-symbols-2  # Required when using e.g., iterm2 / alacritty

  • Debian based distros

    sudo apt install fonts-noto-core

It's enough to install the font, there is no need for configuration changes.

Note Depending on the used system and terminal another font package might be necessary. If you encounter missing glyphs in the the graph: Instead of searching for the correct font package, you can also try setting a different graph style in the config.

Other requirements

  • Ubuntu

    sudo apt install libssl-dev pkg-config

    When using the binaries from the release page, you may need to add libssl manually

    wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.16_amd64.deb ; sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.16_amd64.deb

Alternative installation methods

There are several alternatives to the installation via cargo.

  • Prebuilt binaries for GNU/Linux, macOS and Windows can be downloaded from the the GitHub release page.

  • If you are on NetBSD, a package is available from the official repositories. To install it, simply run

    pkgin install wthrr

  • A Nix flake is also available

    nix profile install "github:ttytm/wthrr-the-weathercrab"
    nix run "github:tobealive/wthrr-the-weathercrab"

  • On Arch Linux wthrr can be installed from the AUR using an AUR helper. For example:

    paru -S wthrr

Build from source

To compile the app yourself, clone the repository and build the release version.

git clone https://github.com/ttytm/wthrr-the-weathercrab.git
cd wthrr-the-weathercrab
cargo build --release

When the build has finished, you will find the wthrr binary inside the ./target/release directory.