Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README, CHANGELOGs, add MSRV to Cargo.toml #34

Merged
merged 2 commits into from
May 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,23 @@
[![Coverage Status](https://coveralls.io/repos/github/djeedai/weldr/badge.svg?branch=main)](https://coveralls.io/github/djeedai/weldr?branch=main)
![Minimum rustc version](https://img.shields.io/badge/rustc-1.61.0+-lightgray.svg)

weldr is a Rust library and command-line tool to manipulate [LDraw](https://www.ldraw.org/) files ([format specification](https://www.ldraw.org/article/218.html)), which are files describing 3D models of [LEGO®](http://www.lego.com)* pieces.
**weldr** is a Rust library and command-line tool to manipulate [LDraw](https://www.ldraw.org/) files ([format specification](https://www.ldraw.org/article/218.html)), which are files describing 3D models of [LEGO®](http://www.lego.com)* pieces.

This repository is a Cargo workspace composed of the following packages:

| Crate | Version | Description | Path |
| Package | Version | Description | Path |
|---|---|---|---|
| [📦 `weldr`](https://crates.io/crates/weldr) | [![Crates.io Version](https://img.shields.io/crates/v/weldr.svg)](https://crates.io/crates/weldr) | The weldr Rust library | [`lib/`](./lib) |
| [📦 `weldr-bin`](https://crates.io/crates/weldr-bin) | [![Crates.io Version](https://img.shields.io/crates/v/weldr-bin.svg)](https://crates.io/crates/weldr-bin) | The ⚙ `weldr` command-line tool | [`bin/weldr/`](./bin/weldr) |

## Library

The weldr library allows building command-line tools and applications leveraging [the fantastic database of pieces](https://www.ldraw.org/cgi-bin/ptlist.cgi) contributed by the LDraw community.
The `weldr` library allows building command-line tools and applications leveraging [the fantastic database of pieces](https://library.ldraw.org/) contributed by the LDraw community.

Parse the content of a single LDraw file containing 2 commands:

```rust
use weldr::{parse_raw, CommandType, CommentCmd, LineCmd, Vec3};

fn main() {}
use weldr::*;

#[test]
fn test_weldr() {
Expand All @@ -46,7 +44,7 @@ fn test_weldr() {

## Command-line tool

The weldr command-line tool ⚙ `weldr` is an executable to manipulate LDraw files and convert them to other formats (currently: glTF 2.0).
The ⚙ `weldr` command-line tool is an executable to manipulate LDraw files and convert them to other formats (currently: glTF 2.0 only).

Convert an LDraw file to a glTF 2.0 file:

Expand All @@ -66,7 +64,7 @@ You can get the list of commands with `weldr --help`. Currently only the `conver
weldr convert [OPTIONS] gltf <INPUT>
```

The official LDraw catalog of parts is available at <https://www.ldraw.org/library/updates/complete.zip>. When using it, use the `--catalog-path` to specify the location where it was downloaded, to allow ⚙ `weldr` to resolve files and all their sub-file references. By default the current working directory is used.
The official LDraw catalog of parts is available at <https://library.ldraw.org/library/updates/complete.zip>. When using it, use the `--catalog-path` to specify the location where it was downloaded, to allow ⚙ `weldr` to resolve files and all their sub-file references. By default the current working directory is used.

## Copyrights

Expand All @@ -83,7 +81,7 @@ Licensed under either of

at your option.

### Contribution
## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license,
Expand Down
7 changes: 7 additions & 0 deletions bin/weldr/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Change Log

## 0.4.0

### Changed

- Upgraded to `weldr` v0.5 for MPD support.
- Bumped minimum rust version (MSRV) to 1.61.

## 0.3.0

Project relicensed to a dual license MIT or Apache 2.0. See `LICENSE-APACHE2` and `LICENSE-MIT`.
Expand Down
5 changes: 3 additions & 2 deletions bin/weldr/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[package]
name = "weldr-bin"
version = "0.3.0"
version = "0.4.0"
rust-version = "1.61"
authors = ["Jerome Humbert"]
description = "A command-line tool to manipulate LDraw files (.ldr)"
license = "MIT OR Apache-2.0"
Expand All @@ -25,7 +26,7 @@ path = "src/weldr.rs"
doc = false

[dependencies]
weldr = { version = "0.4.0", path = "../../lib" }
weldr = { version = "0.5.0", path = "../../lib" }
ansi_term = "0.12"
clap = "2.33"
structopt = "0.3"
Expand Down
14 changes: 14 additions & 0 deletions lib/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Change Log

## 0.5.0

### Added

- Added support for multi-part documents (MPD extension).

### Changed

- Bumped minimum rust version (MSRV) to 1.61.

### Fixed

- Fixed a bug in hybrid file parsing, which discarded some drawing commands. (#32)

## 0.4.0

Project relicensed to a dual license MIT or Apache 2.0. See `LICENSE-APACHE2` and `LICENSE-MIT`.
Expand Down
3 changes: 2 additions & 1 deletion lib/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[package]
name = "weldr"
version = "0.4.0"
version = "0.5.0"
rust-version = "1.61"
authors = ["Jerome Humbert"]
description = "A Rust library to manage LDraw files (.ldr)"
license = "MIT OR Apache-2.0"
Expand Down
Loading