https://github.com/coffee-cup/favocon

Command line utility for creating favicons from a PNG image.
https://github.com/coffee-cup/favocon

Last synced: about 2 months ago
JSON representation

Command line utility for creating favicons from a PNG image.

• Host: GitHub
• URL: https://github.com/coffee-cup/favocon
• Owner: coffee-cup
• License: mit
• Created: 2019-05-19T03:33:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-06T21:36:38.000Z (over 2 years ago)
• Last Synced: 2024-08-09T10:03:00.510Z (5 months ago)
• Language: Rust
• Homepage: https://crates.io/crates/favocon
• Size: 107 KB
• Stars: 15
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Favocon

![CI](https://github.com/coffee-cup/favocon/workflows/CI/badge.svg)

[![crates.io badge](http://meritbadge.herokuapp.com/favocon)](https://crates.io/crates/favocon)

Command line utility for creating

[favicons](https://en.wikipedia.org/wiki/Favicon) from a PNG image.

![favocon-gif](https://user-images.githubusercontent.com/3044853/57985881-5dc5ae80-7a66-11e9-8a8a-fff327b83e73.gif)

## Commands

Create a directory of favicons to be used on your site.

``` shell

favocon icon.png -o outdir/

```

The icon you provide as input must be square.

## Installation

Favocon is available through [Cargo](https://crates.io/crates/favocon).

- Install [Rust](https://www.rust-lang.org/en-US/install.html)

- `cargo install favocon`

- The `favocon` binary will be installed into `$CARGO_HOME/.bin/favocon`. This

  should be in your `PATH` already if you're using rustup.

## Building

- Ensure you have the [Rust toolchain

installed](https://doc.rust-lang.org/cargo/getting-started/installation.html).

- Clone this repo and cd into the directory. 

- Build the project with Cargo.

``` shell

cargo build

```

- Run with `cargo run`.

``` shell

cargo run -- icon.png -o outdir

```