The Reference Implementation for the GRADIFF File Format
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.
The specification of the GRADIFF file format can be found in the GRADIFF Repository.
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 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.
gradiff-rs is (C) 2022 Lucas Hinderberger
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
For details, please refer to the LICENCE file.
gradiff-rs is maintained by Lucas Hinderberger.
You can contact the maintainer 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.