docs: Updated CHANGELOG and README for better installation méthod
This commit is contained in:
parent
0d696c8399
commit
fba68c6c90
@ -1,7 +1,9 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v0.0.1-alpha
|
## v0.0.1-alpha
|
||||||
|
|
||||||
|
- Add docker compose port
|
||||||
|
- Improve install script
|
||||||
|
- Add ttyd for systemd logging
|
||||||
## v0.0.1-rc
|
## v0.0.1-rc
|
||||||
|
|
||||||
- Integrate BirdNET-Analyzer as submodule
|
- Integrate BirdNET-Analyzer as submodule
|
||||||
|
30
README.md
30
README.md
@ -28,13 +28,39 @@ It should work on a Raspberry Pi (or other Single Board Computer) with a USB mic
|
|||||||
|
|
||||||
## Installation
|
## 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 system, you can install BirdNET-stream with the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -sL https://raw.githubusercontent.com/UncleSamulus/BirdNET-stream/main/install.sh | bash
|
curl -sL https://raw.githubusercontent.com/UncleSamulus/BirdNET-stream/main/install.sh | bash
|
||||||
|
``` -->
|
||||||
|
|
||||||
|
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=<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
|
## Usage
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user