Skip to content

Commit

Permalink
Basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
simoncozens committed Apr 17, 2024
1 parent 1dfbdf4 commit d6259f4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Diffenator3

This is a Rust port of
[diffenator2](https://github.com/googlefonts/diffenator2), a utility for
comparing two font files. It comes in two flavours, command line and
WASM.

The command line version is still in very early development, and doesn't
do very much at the moment; it compares two fonts (with burned-in path
names) and outputs a JSON dictionary showing the differences between
them.

The WASM version is a bit more interesting; it can take two font files
over the web and display a HTML report similar to diffenator2. It
doesn't yet compare variable fonts in the same way.

You can use the WASM version at https://simoncozens.github.io/diffenator3

## To rebuild the WASM version

* cargo build --target wasm32-unknown-unknown
* cd www; npm run build

0 comments on commit d6259f4

Please sign in to comment.