Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs and README are not detailed enough #19

Open
YesSeri opened this issue Sep 6, 2021 · 2 comments
Open

Docs and README are not detailed enough #19

YesSeri opened this issue Sep 6, 2021 · 2 comments

Comments

@YesSeri
Copy link

YesSeri commented Sep 6, 2021

I have been trying to use your library in an rust app. I don't understand how to do that. Can you supply a small working example or more detailed docs?

@YesSeri YesSeri changed the title Docs and README are not detailed enough. Docs and README are not detailed enough Sep 6, 2021
@alesgenova
Copy link
Owner

What is the issue you're running into?
The example in the readme should be working as is, other examples can be found in the tests folder.
If you provide me with some more details, I can try crafting a more specific example

@ghost
Copy link

ghost commented Feb 19, 2023

I'll jump in here. When I try to run the program in Readme.md, this is what I get:

$ rustc f.rs
error[E0433]: failed to resolve: maybe a missing crate pitch_detection?
--> f.rs:1:5
|
1 | use pitch_detection::detector::mcleod::McLeodDetector;
| ^^^^^^^^^^^^^^^ maybe a missing crate pitch_detection?
|
= help: consider adding extern crate pitch_detection to use the pitch_detection crate

error[E0433]: failed to resolve: maybe a missing crate pitch_detection?
--> f.rs:2:5
|
2 | use pitch_detection::detector::PitchDetector;
| ^^^^^^^^^^^^^^^ maybe a missing crate pitch_detection?
|
= help: consider adding extern crate pitch_detection to use the pitch_detection crate

error: aborting due to 2 previous errors

For more information about this error, try rustc --explain E0433.
$

I presume this is trivial to fix, but I just want to use pitch detection, not learn Rust :-/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants