https://github.com/l-super/simzip

A minimal C++17 zip library for zip compression and decompression.
https://github.com/l-super/simzip

cpp cpp17 miniz unzip zip

Last synced: about 1 month ago
JSON representation

A minimal C++17 zip library for zip compression and decompression.

• Host: GitHub
• URL: https://github.com/l-super/simzip
• Owner: L-Super
• License: mit
• Created: 2024-05-09T15:35:48.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T10:47:48.000Z (about 2 months ago)
• Last Synced: 2024-10-25T00:46:37.104Z (about 2 months ago)
• Topics: cpp, cpp17, miniz, unzip, zip
• Language: C++
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 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

```cmake

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:

```cpp

#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) License.