Browse Source

Add readme

Sergio Gonzalez 10 years ago
parent
commit
ba2b5eef75
2 changed files with 17 additions and 1 deletions
  1. 16 0
      README.md
  2. 1 1
      tiny_jpeg.h

+ 16 - 0
README.md

@@ -0,0 +1,16 @@
+tiny_jpeg.h
+===========
+
+A header-only public domain implementation of Baseline JPEG compression.
+
+Features:
+---------
+
+- stb-style header only library.
+- Does not do dynamic allocations
+- Simple API:
+    - 2 API calls.
+    - 3-value compression quality: 3 (best quality), 2 (Very good), 1 (Noticeable artifacts, best compression)
+- Public domain
+
+

+ 1 - 1
tiny_jpeg.h

@@ -15,7 +15,6 @@
  *
  * It is written in C99. And depends on the C standard library.
  *
- * Fr
  * Other requirements
  *  - Assumes little endian machine.
  *
@@ -25,6 +24,7 @@
  *  OSX
  *
  * TODO:
+ *  - buffer writes
  *  - add idct and calculate MSE if param passed.
  *  - SSE2 opts.
  *  - error messages