Skip to content

Commit a7ee500

Browse files
committed
Adding lzss.py to README and improvind documentation
1 parent cd3f1dc commit a7ee500

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

Diff for: extras/tools/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,19 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
3838
0000030 0000 0000 7485 0000 0000 0000 0000 0000
3939
```
4040

41+
## `lzss.py`
42+
This tool allows to compress a binary file using the LZSS algorithm.
43+
44+
### How-To-Use
45+
* Encoding (Compressing)
46+
```bash
47+
./lzss.py --encode sketch.bin sketch.lzss
48+
```
49+
* Decoding (Extracting)
50+
```bash
51+
./lzss.py --decode sketch.lzss sketch.bin
52+
```
53+
4154
## `bin2json.py`
4255
This tool converts the binary file into base64 encoded JSON which is necessary for feeding it to the server.
4356

Diff for: extras/tools/lzss.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
LZSS_SO_FILE = "./lzss.so"
77

88
if len(sys.argv) != 4:
9-
print ("Usage: lzss.py --[encode|decode] sketch.bin sketch.lzss")
9+
print ("Usage: lzss.py --[encode|decode] infile outfile")
1010
sys.exit()
1111

1212
lzss_functions = ctypes.CDLL(LZSS_SO_FILE)

0 commit comments

Comments
 (0)