Skip to content

Commit 3d2bf2f

Browse files
chore: fix docs (#98)
Signed-off-by: andreacfromtheapp <3269984+andreacfromtheapp@users.noreply.github.com>
1 parent 1bcd209 commit 3d2bf2f

File tree

10 files changed

+597
-593
lines changed

10 files changed

+597
-593
lines changed

.markdownlint-cli2.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ gitignore: true
1111
# Define glob expressions to ignore
1212
ignores:
1313
- "CHANGELOG.md"
14+
- "README.md"
1415
- ".github/styles/"
1516

1617
# Disable banner message on stdout (only valid at root)

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
A command line utility to help you credit [Freesound](https://freesound.org)
44
samples for a given project more easily.
55

6-
[![Commitlint](https://github.com/gacallea/freesound-credits/actions/workflows/commitlint.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/commitlint.yml)
7-
[![Trufflehog](https://github.com/gacallea/freesound-credits/actions/workflows/trufflehog.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/trufflehog.yml)
8-
[![CI](https://github.com/gacallea/freesound-credits/actions/workflows/ci.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/ci.yml)
9-
[![CD](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml)
10-
[![Release](https://github.com/gacallea/freesound-credits/actions/workflows/release.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/release.yml)
6+
[![Commitlint](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/commitlint.yml/badge.svg)](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/commitlint.yml)
7+
[![Trufflehog](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/trufflehog.yml/badge.svg)](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/trufflehog.yml)
8+
[![CI](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/ci.yml/badge.svg)](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/ci.yml)
9+
[![CD](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/release-plz.yml/badge.svg)](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/release-plz.yml)
10+
[![Release](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/release.yml/badge.svg)](https://github.com/andreacfromtheapp/freesound-credits/actions/workflows/release.yml)
1111
[![Crates.io](https://img.shields.io/crates/v/freesound%2Dcredits.svg)](https://crates.io/crates/freesound-credits)
1212
[![License:
1313
Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -42,7 +42,7 @@ cargo binstall freesound-credits
4242
On Linux and macOS homebrew is also available:
4343

4444
```shell
45-
brew install gacallea/tap/freesound-credits
45+
brew install andreacfromtheapp/tap/freesound-credits
4646
```
4747

4848
## Usage
@@ -82,14 +82,14 @@ kept their original samples names per downloads from the platform. For example:
8282
`freesound-credits` should work for any samples stored in a flat folder.
8383
`freesound-credits` filters out metadata files associated with audio imports.
8484
To add more DAWs and associated metadata or extraction, please [file an
85-
issue](https://github.com/gacallea/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
85+
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+).
8686

87-
| DAW | Samples Folder | Metadata | Extraction | Notes |
88-
| :----: | :----: | :----: | :----: | :----: |
89-
| Ableton | `Samples/Imported` | `.asd` | no | |
90-
| Reaper | `Audio Files` | `.reapeaks` | no | |
91-
| Renoise | `SamplesData` | no | `unzip` | [extraction](#renoise-extraction) |
92-
| Logic Pro X | `Audio Files` | no | no | [Package vs Folder](https://www.youtube.com/watch?v=33zVydB4MiI) |
87+
| DAW | Samples Folder | Metadata | Extraction | Notes |
88+
| :---------: | :----------------: | :---------: | :--------: | :--------------------------------------------------------------: |
89+
| Ableton | `Samples/Imported` | `.asd` | no | |
90+
| Reaper | `Audio Files` | `.reapeaks` | no | |
91+
| Renoise | `SamplesData` | no | `unzip` | [extraction](#renoise-extraction) |
92+
| Logic Pro X | `Audio Files` | no | no | [Package vs Folder](https://www.youtube.com/watch?v=33zVydB4MiI) |
9393

9494
### Adding more DAWs
9595

@@ -99,7 +99,7 @@ files folder, thus I decided to add it but it hasn't been tested.
9999

100100
However, any DAW with these characteristics should work out of the box. I would
101101
appreciate anybody confirming more DAWs or [adding new
102-
ones](https://github.com/gacallea/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+).
102+
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+).
103103
When you do request or add a new DAW, please keep the [above
104104
table](#supported-daws) and the [extra steps](#extra-daws-steps) section in
105105
mind for any extra information.

TODO.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TODO
2+
3+
- add test for `get_list_of_samples`{.verbatim} in `lib.rs`{.verbatim}
4+
- add support for Zola front-matter template
5+
- given a `zolafm-template.toml`{.verbatim}
6+
- read/parse file
7+
- use it with `set_frontmatter`{.verbatim}
8+
- if no template -\> defaults to current hard-coded one

TODO.org

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/CODE_OF_CONDUCT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# The Rust Code of Conduct
2+
3+
The Code of Conduct for this repository [can be found
4+
online](https://www.rust-lang.org/conduct.html).

docs/CODE_OF_CONDUCT.org

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)