gotthardtz / paq8px-lite-t3 Goto Github PK


                              PAQ8PX-LITE README

---------
COPYRIGHT
---------

    Copyright (C) 2008 Matt Mahoney, Serge Osnach, Alexander Ratushnyak,
    Bill Pettis, Przemyslaw Skibinski, Matthew Fite, wowtiger, Andrew Paterson,
    Jan Ondrus, Andreas Morphis, Pavel L. Holoborodko, Kaido Orav, Simon Berger,
    Neill Corlett, Márcio Pais, Andrew Epstein, Mauro Vezzosi, Zoltán Gotthardt,
    Sebastian Lehmann, Moisés Cardona, Byron Knoll

    We would like to express our gratitude for the endless support of many 
    contributors who encouraged PAQ8PX development with ideas, testing, 
    compiling, debugging:
    LovePimple, Skymmer, Darek, Stephan Busch, m^2, Christian Schneider,
    pat357, Rugxulo, Gonzalo, a902cd23, pinguin2, Luca Biondi - and many others.

-------
LICENCE
-------

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of
    the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details at
    Visit <http://www.gnu.org/copyleft/gpl.html>.


    For a summary of your rights and obligations in plain language visit 
    https://tldrlegal.com/license/gnu-general-public-license-v2

-----
ABOUT
-----

PAQ is a series of experimental lossless data compression software that have gone 
through collaborative development to top rankings on several benchmarks measuring 
compression ratio (although at the expense of speed and memory usage).

PAQ8PX-lite (this branch) is a fork from PAQ8PX (https://github.com/hxim/paq8px) 
in 2021 by Zoltán Gothardt which is further forked and tuned for subsequent 
"Global Data Compression Competition 2021" submissions.

----------------------
COMMAND LINE INTERFACE
----------------------

A graphical user interface is not provided, PAQ8PX-LITE runs from the command line.
See the help screen for command line options.
For the help screen just launch PAQ8PX-LITE from the command line without any options.

-----------
SOURCE CODE
-----------

https://github.com/GotthardtZ/paq8px-lite-t3

--------------
HOW TO COMPILE
--------------

Building PAQ8PX-LITE requires a C++17 capable C++ compiler:
https://en.cppreference.com/w/cpp/compiler_support#cpp17

Windows 
To build an executable you may use the Visual Studio solution
file or in case of Mingw-w64 see the "build-mingw-w64-generic-publish.cmd" batch file
in the /build subfolder.

Linux/macOS
gcc users may run the build/build-linux.sh script or use the following commands to build:

 sudo apt-get install build-essential
 g++ -fno-rtti -std=gnu++1z -DNDEBUG -O3 -m64 -march=native -mtune=native -flto -fwhole-program  ../file/*.cpp ../model/*.cpp ../*.cpp -opaq8px-lite.exe 

The following compilers were tested and verified to compile/work correctly:

  - Visual Studio 2019 Community Edition 16.10.4 (Windows)
  - MinGW-w64 9.3.0 (Windows)
  - GCC 10.3.0 (Lubuntu)