https://github.com/chayleaf/librarian

A Rust crate for downloading and linking to non-rust libraries from app build scripts
https://github.com/chayleaf/librarian

Last synced: 5 days ago
JSON representation

A Rust crate for downloading and linking to non-rust libraries from app build scripts

• Host: GitHub
• URL: https://github.com/chayleaf/librarian
• Owner: chayleaf
• License: other
• Created: 2020-06-18T17:19:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-22T09:47:57.000Z (about 4 years ago)
• Last Synced: 2024-04-24T16:24:26.444Z (7 months ago)
• Language: Rust
• Size: 22.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-0BSD

Awesome Lists containing this project

README

        
[![crates.io](https://img.shields.io/crates/v/librarian.svg)](https://crates.io/crates/librarian)

[![docs.rs](https://docs.rs/librarian/badge.svg)](https://docs.rs/librarian/)

# Librarian - a Rust crate for downloading and linking to non-rust libraries from app build scripts

When I started using C libraries in Rust on Windows, what bothered me a lot was the fact that while normally building a crate just requires `cargo build`, if you have to link to a C library and especially if you have to use a DLL, the process becomes more complicated. To eliminate that, I made this crate for myself and am publishing it in hope it will be useful to others.

Do note that right now the project is only tested in a limited amount of environments, so I don't guarantee it will work for you, and I don't guarantee backwards compatibility. However if it doesn't work for you you're welcome to contribute!

It probably isn't feasible to integrate with all the different build systems there are to allow automatically fetching source and building it. While it makes me appreciate the Rust build system, it means automatic downloading will only work for prebuilt libraries.

## (Current) Features

- Downloading .zip/.tgz archives with prebuilt C libraries

- A wrapper for adding a link search path (`cargo:rustc-link-search`)

- A way to copy .dll/.so files to the build folder (Currently only makes sense to do from app build scripts, not lib build scripts)

## Installing

To use Librarian in your build script, add the following to your Cargo.toml:

```toml

[build-dependencies]

librarian = "*"

```

## License

TL;DR do whatever you want

Licensed under either the [BSD Zero Clause License](LICENSE-0BSD) (https://opensource.org/licenses/0BSD), the [Apache 2.0 License](LICENSE-APACHE) (http://www.apache.org/licenses/LICENSE-2.0) or the [MIT License](LICENSE-MIT) (http://opensource.org/licenses/MIT), at your choice.