Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dogacancolak authored Sep 21, 2020
1 parent be04aca commit f7c7213
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Arith
A lossy image compression algorithm that utilizes bitpacking.
A lossy image compression algorithm that utilizes bit packing.

## Installation
### Installation
* Unfortunately, it is not possible to run the project on your machine, since the required libraries are hosted in Tufts servers.

## Usage
### Usage
* To compress an image, run the executable with appropriate png or pnm image using:
```
40image -c [filename]
Expand All @@ -13,12 +13,30 @@ A lossy image compression algorithm that utilizes bitpacking.
```
40image -d [filename]
```

## Algorithm
It is a very algorithm, I recommend to check the [project spec](https://www.cs.tufts.edu/comp/40-2011f/homework/arith.html).
### Explanation of Files
* __40image.c__ is the main() in which the program is ran.

## Contributing
* __compress40__ has the functions for compressing and decompressing, which are
called by 40image

* Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
* __convert__ has functions to convert from rgb space to video space and vice
versa.

* __dct__ has functions that transfrom y, pb, pr to dct float values and vice
versa.

* __quant__ has functions that quantize dct float values into indices and vice
versa.

* __wordpack__ has functions that pack quantized dct values into 32-bit codewords
and vice versa.

* __bitpack__ has functions that are used by wordpack in order to directly
manipulate the bits in a word.

### Algorithm
It is a very lengthy algorithm, I recommend to check the [project spec](https://www.cs.tufts.edu/comp/40-2011f/homework/arith.html).

### Contributing
* Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
* Please make sure to update tests as appropriate.

0 comments on commit f7c7213

Please sign in to comment.