diff --git a/README.md b/README.md index a8a5687f1..cc2032fe3 100644 --- a/README.md +++ b/README.md @@ -12,29 +12,43 @@ based on their syntax. See [the manual](http://difftastic.wilfred.me.uk/) to get started. -## Screenshots +## Demo: Wrapping Expressions + +Difftastic understands expression nesting. If you wrap an expression +in an if statement, difftastic understand that the inner values are +unchanged. + +![Elisp screenshot](img/elisp.png) + +Compare this with git's default diff. It is confused by indentation +changes, and doesn't know which additional closing paren has been added. + +![Elisp comparison screenshot](img/elisp_comparison.png) + +## Demo: Reflowing Code + +Difftastic is robust to code formatting changes. If you change how +many items appear on a single line, difftastic will only show you +items which have changed. ![Rust screenshot](img/rust.png) -![C screenshot](img/c.png) +In git's default diff, it's harder to see that `iter` and the curly +braces are unchanged. It's also harder to see the affected line numbers. -![Haskell screenshot](img/haskell.png) +![Rust comparison screenshot](img/rust_comparison.png) ## Languages @@ -91,8 +105,3 @@ details. Files in `sample_files/` are also under the MIT license unless stated otherwise in their header. - -## Further Reading - -The [wiki](https://github.com/Wilfred/difftastic/wiki) includes -additional notes on alternative diffing techniques and tools. diff --git a/img/c.png b/img/c.png deleted file mode 100644 index 813abc8b9..000000000 Binary files a/img/c.png and /dev/null differ diff --git a/img/elisp.png b/img/elisp.png new file mode 100644 index 000000000..a0e7df808 Binary files /dev/null and b/img/elisp.png differ diff --git a/img/elisp_comparison.png b/img/elisp_comparison.png new file mode 100644 index 000000000..502b02e01 Binary files /dev/null and b/img/elisp_comparison.png differ diff --git a/img/haskell.png b/img/haskell.png deleted file mode 100644 index 1f8a59c44..000000000 Binary files a/img/haskell.png and /dev/null differ diff --git a/img/rust.png b/img/rust.png index f6e7a4f3b..ceb17be0c 100644 Binary files a/img/rust.png and b/img/rust.png differ diff --git a/img/rust_comparison.png b/img/rust_comparison.png new file mode 100644 index 000000000..22742f2d5 Binary files /dev/null and b/img/rust_comparison.png differ