Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.3 KB

README.md

File metadata and controls

45 lines (35 loc) · 1.3 KB
Raw

SimZip - A C++ Wrapper for miniz Library

SimZip is a lightweight C++ 17 library that provides easy-to-use functionalities for zip and unzip operations using the miniz library.

It aims to simplify the process of working with ZIP archives in C++ projects.

Features

  • Simple and intuitive API for compressing and decompressing files.
  • Cross-platform (Windows, Linux, macOS).
  • No external dependencies other than the miniz library.

Usage

CMake FetchContent

include(FetchContent)
FetchContent_Declare(SimZip
        GIT_REPOSITORY https://github.com/L-Super/SimZip.git
        GIT_TAG "main")
FetchContent_MakeAvailable(SimZip)

target_link_libraries(${PROJECT_NAME} SimZip)

Here's a basic example of how to use SimZip to compress and decompress files:

#include "SimZip.h"
// create a zip
SimZip zip("test.zip", SimZip::OpenMode::Create);
zip.add("test.txt"); // add file
zip.add("../SimZip.cpp", "folder/SimZip.cpp"); // add file to folder
zip.add("test1.txt", "text.txt"); // add and rename file
zip.save();

// extract zip
SimZip zip("test.zip", SimZip::OpenMode::Read);
zip.extract("test.txt", "output/"); //extract single file
zip.extractall("output/"); // extract all files

Contributing

Contributions are welcome!

License

SimZip is distributed under the MIT License.