diff --git a/README.md b/README.md index 808de76..0027cbd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # BOSWatch Python Script to Recive and Decode BOS Information with rtl_fm ans multimon-NG -### Fetaures -#####Actual implementet: +### Features +#####Implementeted Features: - FMS and ZVEI decoding and Displaying - Filtering double alarms with adjustable time - ZVEI validation (plausibility test) @@ -10,12 +10,22 @@ Python Script to Recive and Decode BOS Information with rtl_fm ans multimon-NG - All configurations in seperate File "config.ini" - simple Web Frontend -#####Fetaures for the Future: +#####Features for the Future: - extensive filtering options - POCSAG 512,1200,2400 support - automatic Audio recording at alarm - Web Frontend with configuration +### Configuration +##### boswatch.py +To use the boswatch.py script, you must edit the "config.ini". +Now you must set the Userdata to your local MySQL Database. +For the other Functions see "Usage" below. + +##### Web Frontend +Put the Files in Folder /wwww/ into your local Webserver Folder (/var/www/). +Now you must edit the "config.php" with your Userdata to yout local Database. + ### Usage `sudo python boswatch.py -f 85.235M -a FMS ZVEI -s 50` Starts boswatch at Frequency 85.235 MHz with the Demodulation Functions FMS and ZVEI. @@ -45,4 +55,4 @@ optional arguments: -v, --verbose Shows more Information More Options you can find in the extern config.ini File in this Folder -``` \ No newline at end of file +```