Skip to content

Commit

Permalink
update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
minimapletinytools committed Jan 5, 2024
1 parent c2c7f22 commit e21fd4a
Showing 1 changed file with 5 additions and 26 deletions.
31 changes: 5 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,22 @@ tinytools is still in BETA and may be unstable. Save often!!!
## pre-requisites

This library depends on [text-icu](https://hackage.haskell.org/package/text-icu) which depends on the well-respected [ICU
library](https://icu.unicode.org/) which must be installed separately:

### macOS

brew install icu4c
brew link icu4c --force

You might also need:

export PKG_CONFIG_PATH="$(brew --prefix)/opt/icu4c/lib/pkgconfig"

### Debian/Ubuntu

sudo apt-get update
sudo apt-get install libicu-dev

### Fedora/CentOS

sudo dnf install unzip libicu-devel

### Nix/NixOS

nix-shell --packages icu

library](https://icu.unicode.org/) which must be installed separately. Please see [text-icu](https://hackage.haskell.org/package/text-icu) for instructions on how to install icu.

## from binaries


Binaries are available for x86-64 OSX and Linux:

```
curl -sSL https://raw.githubusercontent.com/minimapletinytools/tinytools-vty/potato/install_tinytools.sh | bash
```

Or see [https://github.com/minimapletinytools/tinytools-vty/releases](releases)
NOTE currently ICU is dynamically linked and it's hardcoded to a specific version.
The linux version is hard-linked to v70 and the mac binary is hard-linked to v73
the mac one should work fine if you installed icu4c via brew, however different linux distros seem to ship different versions of libicu-dev so that may not work for you :(.

And perhaps someone will eventually upload this to a package manager for us 🥺
If the binaries do not work, please build from source until I figure out a better way around this :(

## from source

Expand Down

0 comments on commit e21fd4a

Please sign in to comment.