GRADIFF

The Reference Implementation for the GRADIFF File Format

Status: Active Crate: gradiff API Reference Issue Tracker License: MPLv2.0 Badges made with ./badges

Summary

gradiff-rs is the Rust-based reference implementation for the GRADIFF file format. It consists of the codec module, which is responsible for en- and decoding GRADIFF files syntactically and the model crate, which validates GRADIFF files semantically and aggregates GRADIFF Changes.

This library is focused on enabling programs to read and write the GRADIFF file format syntactically and semantically. Rendering of GRADIFF files is out of scope for this library, please refer to GRADIS instead (see https://codeberg.org/gradis/gradis).

In the long term, C and JavaScript bindings are planned.

Specification

The specification of the GRADIFF file format can be found in the GRADIFF Repository.

Contributing

Feel free to contribute by posting issues on this repository's Issue Tracker.

Please note that pull requests are only accepted if they are in line with the licensing of the rest of the project (see below).

Versioning and Compatibility

Versioning of gradiff-rs follows the Semantic Versioning convention.

Until 1.0.0, any substantial changes to the library (breaking and non-breaking) will trigger an increase of the minor version, while bug fixes and similar minor improvements may trigger an increase of the patch version.

Copyright and Licensing

gradiff-rs is (C) 2022 Lucas Hinderberger

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

For details, please refer to the LICENCE file.

Author and Contact

gradiff-rs is authored by Lucas Hinderberger.

You can contact the author via email at lhinderberger@gradis-project.org

The repository of gradiff-rs can be found at https://codeberg.org/gradis/gradiff-rs

You're welcome to file issues and pull requests there.