Commit f9d149a5 authored by Matthias Carnein's avatar Matthias Carnein

Improved documentation

parent 1a88a4f1
......@@ -8,7 +8,7 @@ In addition, the entire lossy compression pipeline is implemented in R for easy
## Installation
The easiest way to install the packageis by using devtools:
The easiest way to install the package is by using devtools:
```R
devtools::install_git("https://wiwi-gitlab.uni-muenster.de/m_carn01/jpegToolbox")
......@@ -19,7 +19,7 @@ Alternatively, the package can be build from source.
## libjpeg Interface
The package provides an interface to the popular libjpeg and libjpeg-turbo libraries.
The package provides an interface to the popular libjpeg (and libjpeg-turbo) libraries.
The interface is similar to the R-package 'jpeg' but allows to change more compression settings.
The path to libjpeg needs to be specified in the src/makevars.win (Windows) or src/makevars (unix) files.
......@@ -57,7 +57,7 @@ plot(image)
## Custom Implementation
The library also provides its own implementations for all lossy compressions steps using similar syntax:
The library also provides its own implementations for all lossy compression steps using similar syntax:
```R
compressed = compressJpeg(image, quality = 100, subsampling = "444", force_baseline=T, linear=F, fancyDownsampling=T, libjpeg=6)
......@@ -68,7 +68,7 @@ plot(decompressed)
```
The above wrapper functions call the individual compressions and decompression steps one by one. This can also be done manually:
The above wrapper functions call the individual compression and decompression steps one by one. This can also be done manually:
```R
## color conversion to YCbCr
......@@ -108,3 +108,7 @@ plot(decompressed)
```
Internally all functions interface c++, however most functions also provide a corresponding R implementation which is considerably slower but easier for debugging.
## Acknowledgement
This software is based in part on the work of the Independent JPEG Group.
LICENSE TERMS (ships as a part of the libjpeg package in the README file)
=============
1. We don't promise that this software works. (But if you find any bugs,
please let us know!)
2. You can use this software for whatever you want. You don't have to pay us.
3. You may not pretend that you wrote this software. If you use it in a
program, you must acknowledge somewhere in your documentation that
you've used the IJG code.
In legalese:
The authors make NO WARRANTY or representation, either express or implied,
with respect to this software, its quality, accuracy, merchantability, or
fitness for a particular purpose. This software is provided "AS IS", and you,
its user, assume the entire risk as to its quality and accuracy.
This software is copyright (C) 1991-2016, Thomas G. Lane, Guido Vollbeding.
All Rights Reserved except as specified below.
Permission is hereby granted to use, copy, modify, and distribute this
software (or portions thereof) for any purpose, without fee, subject to these
conditions:
(1) If any part of the source code for this software is distributed, then this
README file must be included, with this copyright and no-warranty notice
unaltered; and any additions, deletions, or changes to the original files
must be clearly indicated in accompanying documentation.
(2) If only executable code is distributed, then the accompanying
documentation must state that "this software is based in part on the work of
the Independent JPEG Group".
(3) Permission for use of this software is granted only if the user accepts
full responsibility for any undesirable consequences; the authors accept
NO LIABILITY for damages of any kind.
These conditions apply to any software derived from or based on the IJG code,
not just to the unmodified library. If you use our work, you ought to
acknowledge us.
Permission is NOT granted for the use of any IJG author's name or company name
in advertising or publicity relating to this software or products derived from
it. This software may be referred to only as "the Independent JPEG Group's
software".
We specifically permit and encourage the use of this software as the basis of
commercial products, provided that all warranty or liability claims are
assumed by the product vendor.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment