Skip to content

Commit

Permalink
Converage alias.
Browse files Browse the repository at this point in the history
  • Loading branch information
metasim committed Mar 15, 2024
1 parent d335d78 commit 3c27eb2
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions .cargo/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ TEST_DATA_DIR = { value = "tests/data", relative = true }
[alias]
# Run clippy, raising warnings to errors
nowarn = "clippy --all-targets -- -D warnings"
coverage = "tarpaulin --out Html --output-dir target --rustflags=-Clink-arg=-lc++"

[target.aarch64-apple-darwin]
rustflags = [
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

This crate provides Rust bindings for the [PDAL](https://pdal.io) library.

THIS IS A WORK IN PROGRESS. The API is not stable and is subject to change.

Contributions welcome!
15 changes: 13 additions & 2 deletions pdal-sys/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
Before building, make sure you run this command first.
# `pdal-sys` Notes

git submodule update --init --recursive vendor
We currently vendor the [PDAL CAPI](https://github.com/PDAL/CAPI) source code in the `vendor` directory via a git submodule.
Part of this is due to it being a package not readily available in most package managers,
and part of it is due to the fact that we're relying on tweaks to a fork that are not rolled into the official release yet.
One of those tweaks is to compile the CAPI as a static library, so as to be bundled inside with the final binary.

## Setup

Before building, you may need to this command first.

git submodule update --init --recursive vendor

The `build.rs` file attempts to do this for you, but it may not work in all cases.

0 comments on commit 3c27eb2

Please sign in to comment.