Skip to content

Commit 1f97613

Browse files
committed
updated readme and changelog
1 parent 398748c commit 1f97613

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## Unreleazed
9+
10+
### Added
11+
12+
- Windows (x64) support (#91)
13+
814
## [3.4.0] - 2023-12-16
915

1016
### Added

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,25 @@ with Creator("test.zim") as creator:
166166
| `APPLE_SIGNING_KEYCHAIN_PATH` | `/tmp/build.keychain` | Path to the Keychain containing the certificate to sign for macOS with |
167167
| `APPLE_SIGNING_KEYCHAIN_PROFILE` | `build` | Name of the profile in the specified Keychain |
168168

169+
170+
### Building on Windows
171+
172+
On Windows, built wheels needs to be fixed post-build to move the bundled DLLs (libzim and libicu)
173+
next to the wrapper (Windows does not support runtime path).
174+
175+
After building you wheel, run
176+
177+
```ps
178+
python setup.py repair_win_wheel --wheel=dist/xxx.whl --destdir wheels\
179+
```
180+
181+
Similarily, if you install as editable (`pip install -e .`), you need to place those DLLs at the root
182+
of the repo.
183+
184+
```ps
185+
Move-Item -Force -Path .\libzim\*.dll -Destination .\
186+
```
187+
169188
### Examples
170189

171190
##### Default: downloading and bundling most appropriate libzim release binary

0 commit comments

Comments
 (0)