Documentation and Rust Implementation to learn how most famous file formats store data.
Go to file
Théo LUDWIG b1f7ee9987
All checks were successful
ci / ci (push) Successful in 31s
ci / lint-markdown (push) Successful in 8s
ci / lint-commit (push) Successful in 31s
docs: add HEIC image file format in Summary
2024-01-23 18:55:48 +00:00
.github/workflows docs: add links 2023-12-07 00:44:30 +01:00
documentation docs: add HEIC image file format in Summary 2024-01-23 18:55:48 +00:00
src chore: initial commit 2023-12-07 00:12:28 +01:00
.editorconfig chore: initial commit 2023-12-07 00:12:28 +01:00
.gitattributes chore: initial commit 2023-12-07 00:12:28 +01:00
.gitignore chore: initial commit 2023-12-07 00:12:28 +01:00
.markdownlint-cli2.jsonc docs: add links 2023-12-07 00:44:30 +01:00
book.toml chore: initial commit 2023-12-07 00:12:28 +01:00
Cargo.lock chore: initial commit 2023-12-07 00:12:28 +01:00
Cargo.toml chore: initial commit 2023-12-07 00:12:28 +01:00
README.md docs: add links 2023-12-07 00:44:30 +01:00

FileFormats

Documentation and Rust Implementation to learn how most famous file formats store data.

FileFormats Logo


About

  • Documentation: Explains the theory for each file format, the advantages and disadvantages compared to other file formats in the same category, why it is stored in that way, and the User Manual for the implementation.
  • fileformats Implementation: Command-Line Interface and Rust Library to cover most common features of each file format, and understand practically how the theory works. The features of the implementation include, but is not limited to, read, write, convert, and compare between file formats.

Getting Started

Prerequisites

Commands

# Run `fileformats` CLI
cargo run --help

# Documentation
cargo bin mdbook serve

# Build, Lint, and Test
cargo build
cargo test
cargo clippy --verbose -- -D warnings
cargo fmt -- --check