Skip to content

Commit 212eca6

Browse files
committed
reformatted README.MD
1 parent d34d856 commit 212eca6

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,41 @@ uCompression provides RLE compression and decompression functions for microcontr
55
## Compressing data
66

77
```javascript
8-
uint16_t uCompression::RLEcompress( const uint8_t *uncompressedData, uint8_t *compressedData, uint16_t chunkSize );
8+
uint16_t uCompression::RLEcompress( const uint8_t* uncompressedData,
9+
uint8_t* compressedData,
10+
uint16_t chunkSize );
911
```
10-
or
12+
or when compressing data already stored in the program memory:
1113
1214
```javascript
13-
uint16_t uCompression::pgm_RLEcompress( const uint8_t *uncompressedData, uint8_t *compressedData, uint16_t chunkSize );
15+
uint16_t uCompression::pgm_RLEcompress( const uint8_t* uncompressedData,
16+
uint8_t* compressedData,
17+
uint16_t chunkSize );
1418
```
15-
if you need to compress data stored in the program memory (e.g. on AVR systems).
16-
1719
1820
## Uncompressing data
1921
If the compressed data is stored in RAM, it can be uncompressed by
2022
2123
```javascript
22-
const uint8_t *uCompression::RLEdecompress( const uint8_t *compressedData, uint8_t *uncompressedData, uint16_t chunkSize );
24+
const uint8_t* uCompression::RLEdecompress( const uint8_t* compressedData,
25+
uint8_t* uncompressedData,
26+
uint16_t chunkSize );
2327
```
2428
2529
If the compressed data is stored in the program memory, the data can be decompressed with
2630
2731
```javascript
28-
const uint8_t *uCompression::pgm_RLEdecompress( const uint8_t *compressedData, uint8_t *uncompressedData, uint16_t chunkSize );
32+
const uint8_t* uCompression::pgm_RLEdecompress( const uint8_t* compressedData,
33+
uint8_t* uncompressedData,
34+
uint16_t chunkSize );
2935
```
3036
3137
In the common case that the chunk size doesn't exceed 256 bytes, a slightly smaller and faster version can be used:
3238
3339
```javascript
34-
const uint8_t *uCompression::pgm_RLEdecompress256( const uint8_t *compressedData, uint8_t *uncompressedData, uint8_t chunkSize );
40+
const uint8_t* uCompression::pgm_RLEdecompress256( const uint8_t* compressedData,
41+
uint8_t* uncompressedData,
42+
uint8_t chunkSize );
3543
```
3644
3745

0 commit comments

Comments
 (0)