Fix license zlib/libpng to zlib.

Fix usage display.
uniabis · Mar 28, 2019 · 577eabd · 577eabd
1 parent e0813eb
commit 577eabd
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 18 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,25 @@
+ LZEe - LZE enhancement for Z80 by uniabis
+
+ LZE
+ Copyright (C)1995,2008 GORRY.
+
+ License:zlib license or original LZE license
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.
diff --git a/lzee.c b/lzee.c
@@ -1,10 +1,10 @@
 /*
- LZEe - LZE enhancement for z80 by uniabis
+ LZEe - LZE enhancement for Z80 by uniabis
 
  LZE
  Copyright (C)1995,2008 GORRY.
 
- License:original LZE license or zlib/libpng license
+ License:zlib license or original LZE license
 
 This software is provided 'as-is', without any express or implied
 warranty. In no event will the authors be held liable for any damages
@@ -600,8 +600,11 @@ void	decode( unsigned long int size )
 
 void	Usage( void )
 {
-	printf( "Usage: lzee e infile outfile (Encode)\n"
-		"       lzee d infile outfile (Decode)\n"
+	printf(
+		"Usage: lzee e infile outfile (Encode without header)\n"
+		"       lzee E infile outfile (Encode with header)\n"
+		"       lzee d infile outfile (Decode without header)\n"
+		"       lzee D infile outfile (Decode with header)\n"
 	);
 	exit(EXIT_FAILURE);
 }

diff --git a/lzee_dec.asm b/lzee_dec.asm
@@ -1,11 +1,11 @@
 ;	LZEe DECODE ROUTINE
 ;
-;	LZEe - LZE enhancement for z80 by uniabis
+;	LZEe - LZE enhancement for Z80 by uniabis
 ;
 ;	LZE Original Copyright (C)1995,2008 GORRY.
 ;	Porting for Z80 by Kei Moroboshi 2017/SEP.
 ;
-; License:original LZE license or zlib/libpng license
+; License:zlib license or original LZE license
 ;
 ; This software is provided 'as-is', without any express or implied
 ; warranty. In no event will the authors be held liable for any damages

diff --git a/readme.md b/readme.md
@@ -1,35 +1,96 @@
-# LZEe - LZE enhancement for z80 by uniabis
+# LZEe - LZE enhancement for Z80 by uniabis
 
   LZE Original Copyright (C)1995,2008 GORRY.
+
   Porting for Z80 by Kei Moroboshi 2017/SEP.
 
- License:original LZE license or zlib/libpng license
+ License:zlib license or original LZE license
 
+## Description
 
-## Usage
+[LZEe](https://github.com/uniabis/lzee) is file compressor/decompressor derivated from [LZE](http://gorry.haun.org/pw/?lze).
 
-```
-lzee.exe E infile outfile
+LZEe is designed to be effective with fast depacking on Z80 machines.
 
- pack infile to outfile with header
+## Usage
 
-lzee.exe e infile outfile
+```
+lzee e infile outfile
 
  pack infile to outfile without header
 
-lzee.exe D infile outfile
+lzee E infile outfile
 
- unpack infile with header to outfile
+ pack infile to outfile with header
 
-lzee.exe d infile outfile
+lzee d infile outfile
 
  unpack infile without header to outfile
 
- header is unpacked size in little endian 32bit integer
+lzee D infile outfile
+
+ unpack infile with header to outfile
+
+ header is unpacked size in big endian 32bit integer
 
 ```
 
-## original LZE readme.txt
+
+## [Benchmarks](https://github.com/uniabis/z80depacker)
+
+### Compression rate
+
+test data:DEOCM-PLD-CV BIOS(16x16KB)
+
+|SectionName|exomizer|mhmt-base|lze|lzee|megalz|pletter|shrinkler|zx7b|
+|-|-|-|-|-|-|-|-|-|
+|MEGASDHC.B00|9,373|9,397|10,092|10,088|9,718|9,706|8,984|9,762|
+|MEGASDHC.B01|4,902|4,923|5,463|5,459|5,124|5,083|4,680|5,091|
+|MEGASDHC.B02|12,494|12,592|13,472|13,468|12,965|12,945|12,148|13,103|
+|MEGASDHC.B03|12,297|12,320|13,187|13,183|12,660|12,700|11,916|12,810|
+|MSX2MAIN.B00|12,740|12,790|13,698|13,694|13,072|13,205|12,276|13,248|
+|MSX2MAIN.B01|13,402|13,485|14,389|14,385|13,917|13,909|13,100|14,002|
+|MSXMUSIC.B00|10,068|10,118|10,830|10,826|10,407|10,466|9,536|10,495|
+|MSX2EXT.B00|12,351|12,370|13,303|13,299|12,833|12,858|11,820|12,964|
+|KANJJ1.B00|6,097|6,454|7,027|7,023|6,514|6,511|5,728|6,591|
+|KANJJ1.B01|3,975|4,241|4,664|4,660|4,320|4,269|3,700|4,424|
+|KANJJ1.B02|10,688|10,960|11,696|11,692|11,362|11,340|10,212|11,629|
+|KANJJ1.B03|10,510|10,765|11,493|11,489|11,161|11,105|10,020|11,451|
+|KANJJ1.B04|10,415|10,708|11,373|11,369|11,016|10,992|9,876|11,327|
+|KANJJ1.B05|10,348|10,610|11,283|11,279|11,012|10,908|9,808|11,341|
+|KANJJ1.B06|10,650|10,934|11,634|11,630|11,281|11,252|10,148|11,601|
+|KANJJ1.B07|9,701|9,953|10,578|10,574|10,247|10,245|9,212|10,586|
+|ALL|160,011|162,620|174,182|174,118|167,609|167,494|153,164|170,425|
+
+
+### Decompression speed
+
+
+test data:ALL(16*16KB)
+
+|packer|unpacker|unpacker size|packed size|unpacking clocks|
+|-|-|-|-|-|
+Exomizer|deexo.asm|            169|        160,011|    108,490,817|
+Exomizer|deexo_180.asm|            168|        160,011|    108,508,513|
+Exomizer|deexo_180_fast.asm|            173|        160,011|     94,297,587|
+Exomizer|deexo_180_fast_jp.asm|            184|        160,011|     93,483,961|
+mhmt|dehrust_ix|            234|        162,620|     45,607,398|
+mhmt|dehrust_stk|            209|        162,620|     41,333,579|
+lze|lzdec|            119|        174,182|     21,831,226|
+lze|lzdec_104|            104|        174,182|     20,141,132|
+lzee|lzee_dec|             99|        174,118|     19,608,607|
+MegaLZ|megalz_dec40|            110|        167,609|     45,653,296|
+Pletter|unpletter	|            170|        167,494|     28,812,190|
+Pletter|unpletter_180|            169|        167,494|     28,812,318|
+Shrinkler|shrinkler_recall_209|            209|        153,164|  2,648,153,963|
+Shrinkler|shrinkler_recall_209_r800|            209|        153,164|  2,648,153,963|
+zx7b|dzx7b_fast|            191|        170,425|     20,907,617|
+zx7b|dzx7b_fast_r800|            193|        170,425|     21,155,467|
+zx7b|dzx7b_slow|             64|        170,425|     33,688,687|
+zx7b|dzx7b_slow_r800|             65|        170,425|     33,936,537|
+
+
+## Original readme
 
 ```
 ------------------------------------------------------------------------