diff --git a/CHANGELOG.md b/CHANGELOG.md index 58dc8c4..4c82771 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,9 @@ # Changelog - ## v0.0.1-alpha +- Add docker compose port +- Improve install script +- Add ttyd for systemd logging ## v0.0.1-rc - Integrate BirdNET-Analyzer as submodule diff --git a/README.md b/README.md index 7362bef..19a8905 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Introduction -BirdNET-stream records sound 24/7 on any Linux computer with a microphone and analyze it using BirdNET algorithm by [**@kahst**](https://github.com/kahst). +BirdNET-stream records sound 24/7 on any Linux computer with a microphone and analyze it using BirdNET algorithm by [**@kahst**](https://github.com/kahst). Bird contacts are stored in a database and are made accessible in a webapp. @@ -28,19 +28,45 @@ It should work on a Raspberry Pi (or other Single Board Computer) with a USB mic ## Installation -On debian based system, you can install BirdNET-stream with the following command: +> **Warning** BirdNET-stream is in early development, and may not work properly... + + + +On debian based systems (tested on Debian Bullseye), the following command should allow you to install the base components without too much trouble: + +```bash +# Change to your installation directory here, /home/$USER/Documents/BirdNET-stream for instance, or /opt/birdnet-stream, or whatever +cd /path/to/installation/directory +# Download installation script +curl -0 https://raw.githubusercontent.com/UncleSamulus/BirdNET-stream/main/install.sh +# Run installation script: +chmod +x ./install.sh +./install.sh ``` -For finer control, or to adapt to your system, you can follow the instructions in the [INSTALL.md](./INSTALL.md) file. +I recommend to add `DEBUG=1` before this command to see the installation steps: +```bash +DEBUG=1 ./install.sh +``` + +To install from a specific git branch, add `BRANCH=` before the command, for instance: + +```bash +BRANCH=dev DEBUG=1 ./install.sh +``` + +For finer control, or to adapt to your system, you can follow the instructions in the [INSTALL.md](./INSTALL.md) file (it may unfortunatly not be accurate for your system). + ## Usage - BirdNET-stream web application can be accessed on any web browser at [https://birdnet.home](https://birdnet.home), from your local network, or at any other hostname you set in nginx configuration, if your public IP is accessible from the internet. -- See the species detected +- See the species detected ## Acknoledgments @@ -49,4 +75,4 @@ For finer control, or to adapt to your system, you can follow the instructions i ## License -BirdNET-stream is licensed under the GNU General Public License v3.0, see [./LICENSE](./LICENSE) for more details. \ No newline at end of file +BirdNET-stream is licensed under the GNU General Public License v3.0, see [./LICENSE](./LICENSE) for more details.