From c934a663d3c4ba5d0200281dc12533144033f6b5 Mon Sep 17 00:00:00 2001 From: cen1 Date: Thu, 7 Mar 2024 19:43:32 +0100 Subject: [PATCH 1/4] add ci badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f58a325..a819ffc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Quazip +![CI](https://github.com/stachenov/quazip/actions/workflows/ci.yml/badge.svg?branch=master) [![Conan Center](https://shields.io/conan/v/quazip)](https://conan.io/center/quazip) QuaZip is the C++ wrapper for Gilles Vollant's ZIP/UNZIP package From 4e0cd24ee22eda3bcc8cbde6577fb76123e2cee3 Mon Sep 17 00:00:00 2001 From: cen1 Date: Thu, 7 Mar 2024 19:48:50 +0100 Subject: [PATCH 2/4] ignore clion --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 4bf0cd3..6078d28 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,5 @@ *.tags *.user *.swp +.idea/ +cmake-* From b531669fafb9fe20928a240173f3f0cd1eda29aa Mon Sep 17 00:00:00 2001 From: cen1 Date: Thu, 7 Mar 2024 19:49:11 +0100 Subject: [PATCH 3/4] link to workflow, fix conan link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a819ffc..9f84a3a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Quazip -![CI](https://github.com/stachenov/quazip/actions/workflows/ci.yml/badge.svg?branch=master) -[![Conan Center](https://shields.io/conan/v/quazip)](https://conan.io/center/quazip) +[![CI](https://github.com/stachenov/quazip/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/stachenov/quazip/actions/workflows/ci.yml) +[![Conan Center](https://shields.io/conan/v/quazip)](https://conan.io/center/recipes/quazip) QuaZip is the C++ wrapper for Gilles Vollant's ZIP/UNZIP package (AKA Minizip) using Trolltech's Qt library. From 97fe4a14b588d58c73e953926ecea13acc5295ad Mon Sep 17 00:00:00 2001 From: cen1 Date: Thu, 7 Mar 2024 20:30:31 +0100 Subject: [PATCH 4/4] add basic build instructions --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f84a3a..94c90cc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Conan Center](https://shields.io/conan/v/quazip)](https://conan.io/center/recipes/quazip) QuaZip is the C++ wrapper for Gilles Vollant's ZIP/UNZIP package -(AKA Minizip) using Trolltech's Qt library. +(AKA Minizip) using Qt library. If you need to write files to a ZIP archive or read files from one using QIODevice API, QuaZip is exactly the kind of tool you need. @@ -25,3 +25,36 @@ Distributed under LGPL, full details in the COPYING file. Original ZIP package is copyrighted by Gilles Vollant, see quazip/(un)zip.h files for details, but basically it's the zlib license. + +## Build + +You need at least the following dependencies: +- zlib +- Qt6, Qt5 or Qt4 (searched in that order) + +If you built Qt from source and installed it, you might need to tell CMake where to find it, for example: `-DCMAKE_PREFIX_PATH="/usr/local/Qt-6.6.2"`. +Alternatively, if you did not install the source build it might look something like: `-DCMAKE_PREFIX_PATH="/home/you/qt-everywhere-src-6.6.2/qtbase/lib/cmake"`. +Replace `qtbase` if you used a custom prefix at `configure` step. + +Qt installed through Linux distribution packages or official Qt online installer should be detected automatically. + +CMake is used to configure and build the project. + +``` +cmake -B build +cmake --build build --config Release +sudo cmake --install build +cmake --build build --target clean +``` + +CMake options + +| Option | Description | Default | +|--------------------------|-------------------------------------------------------------------------------------------------------|--------------| +| `BUILD_SHARED_LIBS` | Build QuaZip as a shared library | `ON` | +| `QUAZIP_INSTALL` | Enable installation | `ON` | +| `QUAZIP_USE_QT_ZLIB` | Use Qt's bundled zlib instead of system zlib (**not recommended**). Qt must be built with `-qt-zlib`. | `OFF` | +| `QUAZIP_ENABLE_TESTS` | Build QuaZip tests | `OFF` | +| `QUAZIP_BZIP2` | Enable BZIP2 compression | `ON` | +| `QUAZIP_BZIP2_STDIO` | Output BZIP2 errors to stdio when BZIP2 compression is enabled | `ON` | +