coolneng/covot
1
0
Fork 0
mirror of https://gitlab.com/akasroua/covot synced 2025-03-12 06:22:25 +01:00
Code Issues Releases Wiki Activity

Add setup and usage sections to readme

Browse Source
This commit is contained in:
coolneng 2020-11-25 12:10:29 +01:00
parent e6018bd753
commit 23a6e29ff9
Signed by: coolneng
GPG Key ID: 9893DA236405AF57
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,3 +1,22 @@
# Covot
Covid tracing bot project for the Universidad of Granada.
## Setup
The project is developed using the [Nix](https://nixos.org/) package manager. Follow the instructions on the website linked above to install it.
You only need to enter a nix-shell to acquire the dependencies:
``` sh
nix-shell
```
## Usage
The bot can be executed using the following command:
```sh
python -m app.bot
```