CONTRIBUTING.md

Contribution

Pull requests very welcome! Once the dust from initial development settles, we'll have a better TODO list.

All contributors agree to license their work under Apache 2.0.

Git Hooks

Set your .git/hooks/* to sh .githooks/check.

Rust

Install and test

After installing rust, run:

cd rust/osm2lanes
cargo test
cargo install trunk
trunk serve

Before sending a PR, please run cargo +nightly fmt to format the code. Note that while the crate targets the current stable Rust the project requires the nightly toolchain for formatting. You can install it by doing rustup toolchain install nightly; this won't change your default toolchain for other work from stable.

Run

osm2lanes ${INPUT_FILE} ${OUTPUT_FILE}

Dev

cargo install trunk
trunk serve

• The web demo is updated with every push on main, see Workflow
• The html website is part of the rest implementation at /osm2lanes-web