Merge branch 'release/0.2'

Author: tessarin

.gitignore

@@ -1,5 +1,4 @@
 dither
 obj/
 imgs/
-*.plist
 *.1

Makefile

@@ -1,4 +1,5 @@
 CFLAGS = -Wall -Isrc/include
+LDLIBS = -lpng
 
 SRCDIR = src
 OBJDIR = obj
@@ -9,7 +10,7 @@ OBJECTS := $(SOURCES:$(SRCDIR)/%.c=$(OBJDIR)/%.o)
 all: dither doc
 
 dither: $(OBJECTS)
-	$(CC) -o $@ $^
+	$(CC) $^ $(LDLIBS) -o $@
 
 analyse:
 	clang $(CFLAGS) --analyze $(SOURCES)

README.md

@@ -1,28 +1,28 @@
 # Dither - Color Quantization and Dithering
 
 This is a small program dedicated to reducing the number of colors in an
-image. It operates with files in binary PPM format ([Portable PixMap][ppm]),
-and features automatic palette generation (using a median-cut algorithm) and
-dithering implemented with the Floyd-Steinberg method.
+image. It operates with files in PNG or binary PPM format ([Portable
+PixMap][ppm]), and features automatic palette generation (using a median-cut
+algorithm) and dithering implemented with the Floyd-Steinberg method.
 
 ## Installing
 
-#### On macOS with [Homebrew][brew]
+#### On macOS with [Homebrew][brw]
 
     $ brew install tessarin/core/dither
 
 #### Manual Installation
 
-Running `make` will compile the program and generate the documentation
-(requires Perl). To install, move the executable and manual file to the
-appropriate directories.
+First, install [`libpng`][lpg]. Running `make` will then compile the program
+and generate the documentation (requires Perl). To install, move the
+executable and manual files to appropriate directories in your system.
 
     $ make
     $ mv dither ~/bin
     $ mv dither.1 ~/man/man1
 
-Individual targets can also be specified for only compiling or generating the
-manual page:
+Individual targets can also be specified to only compile the program or to
+generate the manual page:
 
     $ make dither
     $ make doc
@@ -47,6 +47,32 @@ processing an image. Other possible palettes include:
 Dithering on the final image can be disabled and the program can also be used
 just to generate a palette.
 
+## Samples
+
+#### Automatic Palette
+
+    $ dither -p auto.32 bird-original.png bird-auto.32.png
+
+![original bird](samples/bird-original.png)
+![generated bird](samples/bird-auto.32.png)
+
+#### 1-bit Black & White
+
+    $ dither -p bw flower-original.png flower-bw.png
+
+![original flower](samples/flower-original.png)
+![generated flower](samples/flower-bw.png)
+
+#### 50% Gray Test
+
+Generates a perfect checkerboard pattern.
+
+    $ dither -p bw gray-original.png gray-dithered.png
+
+![original gray](samples/gray-original.png)
+![dithered gray](samples/gray-dithered.png)
+
  [ppm]: https://en.wikipedia.org/wiki/Netpbm_format
- [brew]: https://brew.sh
+ [brw]: https://brew.sh
+ [lpg]: http://www.libpng.org/pub/png/libpng.html
  [man]: dither.pod

dither.pod

@@ -8,17 +8,22 @@ B<dither> [I<-dv>] [I<-p name>[.I<size>]] I<input> I<output>
 
 =head1 DESCRIPTION
 
-B<dither> processes image files in binary PPM format with the goal of reducing
-its number of colors. Functionality includes generating a palette of colors
-automatically and writing the output image with the signal optionally dithered
-(Floyd-Steinberg method).
+B<dither> processes image files in PNG or binary PPM format with the goal of
+reducing its number of colors. Functionality includes generating a palette of
+colors automatically and writing the output image with the signal optionally
+dithered (Floyd-Steinberg method).
 
 Arguments for the input and output file are both required.
 
 The palette used in the operation can be generated from different presets and
 sizes, or be completely customized. Details about palette generation are
 described below in the corresponding section.
 
+The input file format is deduced by analysing the image header. The output
+file format is decided according to its extension. Use a C<.png> extension to
+have output written as a PNG file. Any other extension will result in a binary
+PPM file.
+
 =head2 Options
 
 Accepted options are: