Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@nhz2
nhz2 authored Jul 27, 2024
1 parent f39e76f commit 6817ed2
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@

CodecInflate64 implements deflate64 decompression for the [TranscodingStream.jl](https://github.com/JuliaIO/TranscodingStreams.jl) interface.

This package aims to read entries of ZIP files created by the default Windows archiver.
This package aims to read entries of ZIP files created by the default Windows File Explorer.

Deflate64 is an incompatible variant of deflate that Windows sometimes uses when making ZIP files.
Deflate64 is an incompatible variant of deflate that Windows File Explorer sometimes uses when making ZIP files.

This package is a work in progress, and may not be able to read all deflate64 data correctly.

Check all decompressed data with a checksum.

The deflate algorithm is described in [RFC 1951](https://www.ietf.org/rfc/rfc1951.txt).

Deflate64 has a reference implementation in [dotnet](https://github.com/dotnet/runtime/tree/e5efd8010e19593298dc2c3ee15106d5aec5a924/src/libraries/System.IO.Compression/src/System/IO/Compression/DeflateManaged)
Expand All @@ -30,3 +28,7 @@ This package exports the following codecs and streams:
| `Deflate64Decompressor` | `Deflate64DecompressorStream` |

See [TranscodingStreams.jl](https://github.com/bicycle1885/TranscodingStreams.jl) for details.

Related packages in other programming languages:
- Rust: https://github.com/anatawa12/deflate64-rs
- Python: https://github.com/brianhelba/zipfile-deflate64

3 comments on commit 6817ed2

@nhz2
Copy link
Member Author

@nhz2 nhz2 commented on 6817ed2 Jul 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@nhz2
Copy link
Member Author

@nhz2 nhz2 commented on 6817ed2 Jul 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/111898

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 6817ed203242cda8bf6eed2df523819580802014
git push origin v0.1.0

Please sign in to comment.