FeDirect/README.md

22 lines
548 B
Markdown

# FeDirect
Fedi links that open on your preferred instance!
## Building and Running
To compile TypeScript, the build script assumes Deno is installed.
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
cargo build --release
# Or, to immediately run it
cargo run --release
# Or, to run during development:
cargo run
```