diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7ba65ed..b598aec 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,8 +15,10 @@ jobs: steps: - uses: "actions/checkout@v4" - uses: "dtolnay/rust-toolchain@stable" - + with: + components: "clippy, rustfmt" - run: "rustc --version" + - run: "cargo build --verbose" - run: "cargo test --verbose" - run: "cargo clippy --verbose -- -D warnings" diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 4f38985..f59f82e 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -1,7 +1,32 @@ { "config": { "default": true, - "MD033": false + "no-inline-html": false, + + /* Disables rules that may conflict with Prettier */ + /* Reference: https://github.com/DavidAnson/markdownlint/blob/main/style/prettier.json */ + "blanks-around-fences": false, + "blanks-around-headings": false, + "blanks-around-lists": false, + "code-fence-style": false, + "emphasis-style": false, + "heading-start-left": false, + "hr-style": false, + "line-length": false, + "list-indent": false, + "list-marker-space": false, + "no-blanks-blockquote": false, + "no-hard-tabs": false, + "no-missing-space-atx": false, + "no-missing-space-closed-atx": false, + "no-multiple-blanks": false, + "no-multiple-space-atx": false, + "no-multiple-space-blockquote": false, + "no-multiple-space-closed-atx": false, + "no-trailing-spaces": false, + "ol-prefix": false, + "strong-style": false, + "ul-indent": false }, "globs": ["**/*.md"] } diff --git a/README.md b/README.md index 11fcc4e..ec8b5a6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- FileFormats Logo + FileFormats Logo

--- diff --git a/documentation/Links.md b/documentation/Links.md new file mode 100644 index 0000000..c0b7693 --- /dev/null +++ b/documentation/Links.md @@ -0,0 +1,15 @@ +# Links + +## File formats + +- [MDN - Media type and format guide: image, audio, and video content](https://developer.mozilla.org/en-US/docs/Web/Media/Formats) +- [dav1d - AV1 cross-platform decoder, open-source, and focused on speed and correctness](https://github.com/videolan/dav1d) + +## Rust Resources + +- [Book to get started with the Rust programming language](https://github.com/theoludwig/rust_book) +- [Book for developing Command Line Applications in Rust](https://rust-cli.github.io/book/index.html) +- [human-panic - Panic messages for humans](https://crates.io/crates/human-panic) +- [assert_cmd - Test CLI Applications](https://crates.io/crates/assert_cmd) +- [clap - A simple to use, efficient, and full-featured Command Line Argument Parser](https://crates.io/crates/clap) +- [Rayon - Simple work-stealing parallelism for Rust](https://crates.io/crates/rayon) diff --git a/documentation/README.md b/documentation/README.md index 09c377a..55ab9c1 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -5,7 +5,7 @@

- FileFormats Logo + FileFormats Logo

--- diff --git a/documentation/Resources.md b/documentation/Resources.md deleted file mode 100644 index 2235a48..0000000 --- a/documentation/Resources.md +++ /dev/null @@ -1,4 +0,0 @@ -# Resources - -- [MDN - Media type and format guide: image, audio, and video content](https://developer.mozilla.org/en-US/docs/Web/Media/Formats) -- [dav1d - AV1 cross-platform decoder, open-source, and focused on speed and correctness](https://github.com/videolan/dav1d) diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md index 0cd9591..5d756b5 100644 --- a/documentation/SUMMARY.md +++ b/documentation/SUMMARY.md @@ -1,4 +1,4 @@ # Summary - [FileFormats](./README.md) -- [Resources](./Resources.md) +- [Links](./Links.md)