diff --git a/README.md b/README.md index eb8783f..9e52636 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,15 @@ Fedi links that open on your preferred instance! -## Building +## Building and Running To compile TypeScript, the build script assumes Deno is installed. -When you have Deno and Rust installed, simply use Cargo to build the project +1. [Install Rust via rustup](https://rustup.rs/) +2. [Install Deno](https://deno.com/) +3. Run `install-binary-deps.sh` (this installs the icon scraper and possibly + more in the future) +4. Use Cargo to build the project: ```sh # For example, to build for release, you can do diff --git a/install-binary-deps.sh b/install-binary-deps.sh new file mode 100755 index 0000000..333739c --- /dev/null +++ b/install-binary-deps.sh @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +cargo install site_icons