Mention stage of development in the README
Run tests and update readme on the CI
The readme is in reST
andawardaz collects data from a system such as battery levels or geolocation and sends it to an mqtt server. It is designed to be run from a systemd unit (or other equivalent method) either periodicaly or triggered by events such as a connection to some wifi network.
It was inspired by PresencePublisher for Android, but designed for ease of use on Linux Mobile.
This is still at a very early stage of development, and things may (and will!) break unexpectedly!
To run the full test suite, add a file called mqtt_config.yaml to the project root with the following contents:
mqtt:
server: <a working mqtt server>
topic: <a topic of your choice>
If this file is not found all tests that require an mqtt server will be skipped.
Copyright (C) 2024 Elena Grandi
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.