From 23a6e29ff981e1f3ebdfcb8e3083c83370010101 Mon Sep 17 00:00:00 2001 From: coolneng Date: Wed, 25 Nov 2020 12:10:29 +0100 Subject: [PATCH] Add setup and usage sections to readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 98d51c8..ffd2589 100644 --- a/README.md +++ b/README.md @@ -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 +``` +