Improve docs for building and installation steps #101
Conversation
|
Warning Rate Limit Exceeded@isZumpo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 9 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent update has restructured the documentation of BirdNET-Go, emphasizing installation and building instructions. This aims to enhance clarity, offering detailed guidance for Docker and binary release users, and developers building from source. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (3)
- README.md (1 hunks)
- doc/building.md (1 hunks)
- doc/installation.md (1 hunks)
Additional comments not posted (3)
README.md (1)
36-42: Consider adding a brief overview or summary of the installation and building processes directly in the README.md file.
This can provide readers with immediate context before they navigate to the detailed guides.doc/building.md (1)
3-3: Clarify that the devcontainer approach is specifically designed for VSCode users, to ensure readers understand the context and applicability of this method.doc/installation.md (1)
91-91: Add a note about the necessity of installing other dependencies mentioned in the binary releases section, as it only specifies the TensorFlow Lite C library. This will help users understand all prerequisites for using binary releases.
|
|
||
| Windows executable is in **bin/birdnet.exe**, copy this and **libtensorflowlite_c.so** to your Windows system, library file must be in PATH for birdnet.exe to run properly. | ||
|
|
||
| Yes it is correct that you need **libtensorflowlite_c.dll** in /usr/x86_64-w64-mingw32/lib/ for compile process, and on Windows you need **libtensorflowlite_c.so** for runtime. This sounds backwards but this is how it works. |
There was a problem hiding this comment.
Correct the explanation regarding the use of libtensorflowlite_c.dll and libtensorflowlite_c.so for Windows compilation and runtime. It seems there might be a mix-up in the explanation. Clarify that libtensorflowlite_c.dll is needed for runtime on Windows, not libtensorflowlite_c.so.
- Yes it is correct that you need **libtensorflowlite_c.dll** in /usr/x86_64-w64-mingw32/lib/ for compile process, and on Windows you need **libtensorflowlite_c.so** for runtime.
+ Yes it is correct that you need **libtensorflowlite_c.dll** in /usr/x86_64-w64-mingw32/lib/ for the compile process, and on Windows, you need **libtensorflowlite_c.dll** for runtime.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Yes it is correct that you need **libtensorflowlite_c.dll** in /usr/x86_64-w64-mingw32/lib/ for compile process, and on Windows you need **libtensorflowlite_c.so** for runtime. This sounds backwards but this is how it works. | |
| Yes it is correct that you need **libtensorflowlite_c.dll** in /usr/x86_64-w64-mingw32/lib/ for the compile process, and on Windows, you need **libtensorflowlite_c.dll** for runtime. This sounds backwards but this is how it works. |
doc/installation.md
Outdated
| ### Running BirdNET-GO with Docker - Simple setup | ||
|
|
||
|
|
||
| The command bellow will start a container with the latest version BirdNET-Go: |
There was a problem hiding this comment.
Fix the typo in "bellow" to "below" to correct the instruction text.
- The command bellow will start a container with the latest version BirdNET-Go:
+ The command below will start a container with the latest version BirdNET-Go:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The command bellow will start a container with the latest version BirdNET-Go: | |
| The command below will start a container with the latest version BirdNET-Go: |
doc/installation.md
Outdated
| --env TZ="Europe/Stockholm" | ||
| --device /dev/snd \ | ||
| -v $HOME/BirdNET-Go-Volumes/config:/config \ | ||
| -v $HOME/BirdNET-Go-Volumes/config:/data \ |
There was a problem hiding this comment.
There's a mistake in the volume mapping for the data directory. It should map to /data inside the container, not /config again.
- -v $HOME/BirdNET-Go-Volumes/config:/data \
+ -v $HOME/BirdNET-Go-Volumes/data:/data \Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| -v $HOME/BirdNET-Go-Volumes/config:/data \ | |
| -v $HOME/BirdNET-Go-Volumes/data:/data \ |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit