created changelog in prepartion for v5.

Author: Mike-Neto

CHANGELOG.md

@@ -0,0 +1,58 @@
+### 5.0.0
+
+#### Breaking
+
+Reworked error handling by creating img_diff own Result & Error types.
+
+#### Dependencies
+
+- updated image@0.21.2 to image@0.22.2
+- updated criterion@0.2.11 to criterion@0.3.0
+- updated structopt@0.2.18 to structopt@0.3.6
+- updated predicates@1.0.1 to predicates@1.0.2
+- updated assert_cmd@0.11.1 to assert_cmd@0.12.0
+- swapped tempdir@0.3.7 (deprecated) to tempfile@3.1.0
+
+#### CI
+
+Dropped FreeBSD support (following on cross)
+
+### 4.0.0
+
+Removed Dssim and a bunch of other dependencies.
+
+Now the value shown is a percentage. More details above.
+
+Uniform value no matter the image type.
+
+### 3.0.2
+
+Fixed some issues and migrated to using tools as recommended by the CLI WG
+
+- Migrated to StructOpt
+- Migrated to assert_cmd
+- Added human friendly panic
+
+Removed all unwraps and provide error messages.
+
+Updated dependencies.
+
+More typo fixes.
+
+Updated future features with things from the CLI WG suggestions.
+
+### 3.0.1
+
+Formatted using cargo fmt.
+
+Fixed clippy issues.
+
+Fixed typos and updated docs.
+
+Updated dependencies.
+
+### 3.0.0
+
+Removed Multi-threaded flag making that the default.
+
+Upgraded to Rust Edition 2018

README.md

@@ -11,52 +11,58 @@ Rust based Command line tool to diff images in 2 structurally similar folders an
 The value outputted represent a percentage of how much the amount of pixel data differs from the hightest possible value for that given image in each pixel.
 
 ## Future Features
-* Support multiple format's of images (JPEG).
-* Allow for a threshold to output diff file.
+
+- Support multiple format's of images (JPEG).
+- Allow for a threshold to output diff file.
 
 ### From the CLI WG
-* Revise stdout & stderr efficiency (avoid flush by using a stream).
-* Add logging (log crate)
-* Add Progress bar (indicatif crate)
-* Add types of output (convey crate)
-* Generate a man page (clap crate)
+
+- Revise stdout & stderr efficiency (avoid flush by using a stream).
+- Add logging (log crate)
+- Add Progress bar (indicatif crate)
+- Add types of output (convey crate)
+- Generate a man page (clap crate)
 
 ## Usage
 
     img_diff -s path\to\images -d path\to\images\to\compare -f path\to\output\diff\images
 
 Will go trough all the files in the -s dir and subdirectories and compare them to the ones in the -d outputting diff files if a difference is found to -f dir.
 
-	-v
+    -v
 
 enables verbose mode and output to stderr in case of a difference found.
 
-
 ## Usage in CI
-	img_diff -s path\to\images -d path\to\images\to\compare -f path\to\output\diff\images -v 2> results/output.txt
+
+    img_diff -s path\to\images -d path\to\images\to\compare -f path\to\output\diff\images -v 2> results/output.txt
 
 This will enable verbose output and enable the results of failed comparisons to be put into output.txt
 We can use this to enable CI with
-	
-	if [[ -s results/output.txt ]]; then exit 1; else exit 0; fi
+if [[ -s results/output.txt ]]; then exit 1; else exit 0; fi
 
 ## Compile from source
+
      git clone https://github.com/Mike-Neto/img_diff.git
      cd img_diff
      cargo build --release
 
 ## Build all files
-	cargo build && cargo test && cargo test --benches
+
+    cargo build && cargo test && cargo test --benches
     cargo +beta build && cargo +beta test && cargo +beta test --benches
-	cargo +nightly build && cargo +nightly test && cargo +nightly test --benches
+    cargo +nightly build && cargo +nightly test && cargo +nightly test --benches
 
 ## Test
-	cargo test
+
+    cargo test
 
 ## Docs
+
     cargo doc --open
 
 ## Crate
+
 [Crates.io](https://crates.io/crates/img_diff)
 
 ## Download
@@ -68,6 +74,7 @@ You need [Rust](https://www.rust-lang.org)
 You can also download a binary release for your platform on [github releases](https://github.com/Mike-Neto/img_diff/releases/latest)
 
 ## Publish process
+
     cargo bump (major|minor|patch)
     git commit -m "v4.0.0"
     git tag -a v4.0.0 -m "v4.0.0"
@@ -77,9 +84,11 @@ You can also download a binary release for your platform on [github releases](ht
 ## Benchmarking and Profiling
 
 ### Dependencies
+
     sudo apt install valgrind kcachegrind
 
 ### Local Benchmarks
+
 Will run all all benchmarks against local data.
 
     cargo clean
@@ -89,50 +98,13 @@ Will run all all benchmarks against local data.
     cargo bench
 
 ### Profiling changes
+
     cargo bench img_diff/subtract
     # Check for the binary name which will then be used as input bellow
     valgrind --tool=callgrind --dump-instr=yes --collect-jumps=yes --simulate-cache=yes target/release/deps/bench-f72b65412859cf2f --bench img_diff/subtract
     # Check for the above output file name
     kcachegrind callgrind.out.20282
 
-
-## Changelog
-
-### From 3.0.2
-Removed Dssim and a bunch of other dependencies.
-
-Now the value shown is a percentage. More details above.
-
-Uniform value no matter the image type.
-
-### From 3.0.1
-Fixed some issues and migrated to using tools as recommended by the CLI WG
-* Migrated to StructOpt
-* Migrated to assert_cmd
-* Added human friendly panic
-
-Removed all unwraps and provide error messages.
-
-Updated dependencies.
-
-More typo fixes.
-
-Updated future features with things from the CLI WG suggestions.
-
-### From 3.0.0
-Formatted using cargo fmt.
-
-Fixed clippy issues.
-
-Fixed typos and updated docs.
-
-Updated dependencies.
-
-### From 2.1.0
-Removed Multi-threaded flag making that the default.
-
-Upgraded to Rust Edition 2018
-
 ## License
 
 Copyright 2018 Miguel Mendes