Skip to content

Commit 2d67370

Browse files
committed
update dependencies in readme
1 parent a70a29d commit 2d67370

File tree

1 file changed

+43
-7
lines changed

1 file changed

+43
-7
lines changed

README.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,61 @@ Safe Rust bindings for [MicroTeX](https://github.com/NanoMichael/MicroTeX), a li
1919
Add to your `Cargo.toml`:
2020

2121
```toml
22-
[dependencies]
23-
microtex_rs = "0.1"
22+
[dependencies.microtex_rs]
23+
git = "https://github.com/sctg-development/microtex_rs"
24+
branch = "main"
2425
```
2526

2627
### System Dependencies
2728

28-
By default, `microtex_rs` will attempt to use system-installed graphics libraries:
29+
By default, `microtex_rs` will attempt to use system-installed graphics libraries. The CI workflow installs the following packages per-platform; install the equivalent on your system:
30+
31+
macOS (Homebrew — ARM and Intel):
2932

3033
```bash
31-
# macOS
34+
# macOS (arm64 or intel)
3235
brew install cairo pango fontconfig pkg-config lzo libffi zlib bzip2 graphite2 libpng freetype harfbuzz pixman pcre2
3336

34-
# Ubuntu/Debian
35-
sudo apt-get install libcairo2-dev libpango-1.0-0 libpango1.0-dev libfontconfig1-dev pkg-config
37+
# If you need to build amd64 (intel) binaries on an arm64 mac, use the x86_64 Homebrew and prefix commands with Rosetta:
38+
# arch -x86_64 /usr/local/bin/brew install <pkg>
39+
```
40+
41+
Ubuntu / Debian:
3642

37-
# Fedora
43+
```bash
44+
sudo apt-get update && sudo apt-get install -y libcairo2-dev libpango-1.0-0 libpango1.0-dev libfontconfig1-dev pkg-config
45+
```
46+
47+
Notes for CI/coverage builds: the CI sometimes also installs `pkg-config`, `libssl-dev`, `clang` and `llvm` for certain tooling (coverage, tarpaulin).
48+
49+
Fedora:
50+
51+
```bash
3852
sudo dnf install cairo-devel pango-devel fontconfig-devel pkg-config
3953
```
4054

55+
Windows (vcpkg + MSVC):
56+
57+
```powershell
58+
# Example using vcpkg (run from PowerShell / Admin if needed)
59+
git clone https://github.com/Microsoft/vcpkg.git C:\vcpkg
60+
C:\vcpkg\bootstrap-vcpkg.bat
61+
C:\vcpkg\vcpkg.exe install cairo:x64-windows pango:x64-windows fontconfig:x64-windows pkgconf:x64-windows libpng:x64-windows freetype:x64-windows harfbuzz:x64-windows pixman:x64-windows libffi:x64-windows pcre2:x64-windows zlib:x64-windows bzip2:x64-windows lzo:x64-windows
62+
```
63+
64+
Common build tools (required by the CI):
65+
66+
```bash
67+
# meson and ninja (installed in CI via pip):
68+
python3 -m pip install --break-system-packages meson ninja
69+
70+
# Rust toolchain (use rustup to install 'stable')
71+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
72+
rustup default stable
73+
```
74+
75+
If you prefer to use vendored dependency bundles instead of system libraries, see the **Dependency Bundles** section below.
76+
4177
### Dependency Bundles
4278

4379
The `main` branch prefers system libraries or prebuilt dependency bundles. To create a macOS Intel bundle locally:

0 commit comments

Comments
 (0)