chore: del spellcheck + md fixes + minor changes (#104)

Signed-off-by: andreacfromtheapp <[email protected]>

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -13,13 +13,13 @@ Team member before any CI builds will run.
 
 ## Before submitting a pull request (check all applicable)
 
-- [ ] Read the [Contributing Guide](./github/CONTRIBUTING.md) (required)
-- [ ] Read the [Code Of Conduct](/CODE_OF_CONDUCT.md) (required)
+- [ ] Read the [Contributing Guide](/docs/CONTRIBUTING.md) (required)
+- [ ] Read the [Code Of Conduct](/docs/CODE_OF_CONDUCT.md) (required)
 - [ ] Include tests for your changes (if necessary)
 - [ ] `pre-commit run --all-files` returns no issues (required)
 - [ ] Update any related documentation and include any relevant screenshots
-- [ ] Use [Conventional
-Commits](https://www.conventionalcommits.org/en/v1.0.0/) (required)
+- [ ] Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+      (required)
 
 ## Pull request type (check all applicable)
 

.github/workflows/ci.yml

@@ -107,22 +107,3 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - name: cargo docs
         run: cargo doc --no-deps --document-private-items --all-features --workspace --examples
-
-  # check-spelling:
-  #   name: check-spelling
-  #   needs: basics
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout repository
-  #       uses: actions/checkout@v4
-  #     - name: Install Rust ${{ env.rust_stable }}
-  #       uses: dtolnay/rust-toolchain@stable
-  #       with:
-  #         toolchain: ${{ env.rust_stable }}
-  #     - name: Install cargo-spellcheck
-  #       uses: taiki-e/install-action@v2
-  #       with:
-  #         tool: cargo-spellcheck
-  #     - uses: actions/checkout@v4
-  #     - name: cargo spellcheck
-  #       run: cargo spellcheck --code 1

Cargo.toml

@@ -19,7 +19,7 @@ name = "freesound-credits"
 path = "src/main.rs"
 
 [dependencies]
-clap = { version = "4.5.23", features = ["derive"] }
+clap = { version = "4.5.30", features = ["derive"] }
 
 # Config for 'cargo dist'
 [profile.release]

README.md

@@ -18,13 +18,13 @@ MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/
 
 Giving credits in the [Creative Commons](https://creativecommons.org) community
 is often the sole requirement to freely use samples in your own creations. This
-tool helps you abide to [Copyleft](https://en.wikipedia.org/wiki/Copyleft)
-and credit the generous artists that contribute sounds on
+tool helps you abide to [Copyleft](https://en.wikipedia.org/wiki/Copyleft) and
+credit the generous artists that contribute sounds on
 [Freesound](https://freesound.org), helping you being more creative.
 
-Until today, giving credits may have been a process that you begrudged. This
-may have been stopping you from giving credits altogether. Not because you
-didn't want to, but because it was cumbersome and tedious.
+Until today, giving credits may have been a process that you begrudged. This may
+have been stopping you from giving credits altogether. Not because you didn't
+want to, but because it was cumbersome and tedious.
 
 Not anymore! Thanks to `freesound-credits` it takes seconds now!
 
@@ -80,9 +80,9 @@ kept their original samples names per downloads from the platform. For example:
 ## Supported DAWs
 
 `freesound-credits` should work for any samples stored in a flat folder.
-`freesound-credits` filters out metadata files associated with audio imports.
-To add more DAWs and associated metadata or extraction, please [file an
-issue](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
+`freesound-credits` filters out metadata files associated with audio imports. To
+add more DAWs and associated metadata or extraction, please
+[file an issue](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
 
 |     DAW     |   Samples Folder   |  Metadata   | Extraction |                              Notes                               |
 | :---------: | :----------------: | :---------: | :--------: | :--------------------------------------------------------------: |
@@ -98,11 +98,11 @@ and Renoise projects on macOS. Logic Pro X uses no metadata and a clean Audio
 files folder, thus I decided to add it but it hasn't been tested.
 
 However, any DAW with these characteristics should work out of the box. I would
-appreciate anybody confirming more DAWs or [adding new
-ones](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
-When you do request or add a new DAW, please keep the [above
-table](#supported-daws) and the [extra steps](#extra-daws-steps) section in
-mind for any extra information.
+appreciate anybody confirming more DAWs or
+[adding new ones](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
+When you do request or add a new DAW, please keep the
+[above table](#supported-daws) and the [extra steps](#extra-daws-steps) section
+in mind for any extra information.
 
 ## Extra DAWs steps
 
@@ -114,5 +114,5 @@ Extract with `unzip your_project.xrns` first. Once unzipped, you will find a
 ## Contributing
 
 Thanks for your help improving the project! :balloon: Happy to have you! Peruse
-the [contributing guide](./docs/CONTRIBUTING.org) to help you get involved in
-the project.
+the [contributing guide](./docs/CONTRIBUTING.md) to help you get involved in the
+project.

TODO.md

@@ -1,8 +1,8 @@
 # TODO
 
--   add test for `get_list_of_samples`{.verbatim} in `lib.rs`{.verbatim}
--   add support for Zola front-matter template
-    -   given a `zolafm-template.toml`{.verbatim}
-    -   read/parse file
-    -   use it with `set_frontmatter`{.verbatim}
-    -   if no template -\> defaults to current hard-coded one
+- add test for `get_list_of_samples`{.verbatim} in `lib.rs`{.verbatim}
+- add support for Zola front-matter template
+  - given a `zolafm-template.toml`{.verbatim}
+  - read/parse file
+  - use it with `set_frontmatter`{.verbatim}
+  - if no template -\> defaults to current hard-coded one

docs/CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
 # The Rust Code of Conduct
 
-The Code of Conduct for this repository [can be found
-online](https://www.rust-lang.org/conduct.html).
+The Code of Conduct for this repository
+[can be found online](https://www.rust-lang.org/conduct.html).