From c92d8c53efcbb65d6593a479bc3fe0095b3ca48f Mon Sep 17 00:00:00 2001 From: Samuel ORTION Date: Thu, 18 Aug 2022 09:23:11 +0200 Subject: [PATCH] docs: Update README - Add feature, license sections --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f0e4ec6..7362bef 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,25 @@ ## Introduction -BirdNET-stream record sound on Linux computer and analyze it with the help of the BirdNET algorithm. It extracts most interesting bird songs and calls accessible in a webapp. +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). -## Install +Bird contacts are stored in a database and are made accessible in a webapp. + +## Features + +- 24/7 recording and [BirdNET-Analyzer](https://github.com/kahst/BirdNET-Analyzer) analysis of sound +- Live audio streaming and live spectrogram visualization from web browser +- Bird contacts saved into a SQL database +- Web Interface for system monitoring, data analysis and visualization + +## Requirements + +BirdNET-stream aims to be able to run on any 64-bit Linux computer. +It has been tested on Fedora and Debian. + +It should work on a Raspberry Pi (or other Single Board Computer) with a USB microphone or Sound Card (not tested yet). + +## Installation On debian based system, you can install BirdNET-stream with the following command: @@ -22,7 +38,15 @@ For finer control, or to adapt to your system, you can follow the instructions i ## Usage -## Acknoledgements +- 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 + +## Acknoledgments - [BirdNET](https://birdnet.cornell.edu) on which this project relies - [BirdNET-Pi](https://birdnetpi.com) the great inspiration of this project + +## 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