mirror of
				https://gitlab.com/akasroua/covot
				synced 2025-11-04 02:39:50 +01:00 
			
		
		
		
	Add setup and usage sections to readme
This commit is contained in:
		
							parent
							
								
									e6018bd753
								
							
						
					
					
						commit
						23a6e29ff9
					
				
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							@ -1,3 +1,22 @@
 | 
				
			|||||||
# Covot
 | 
					# Covot
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Covid tracing bot project for the Universidad of Granada.
 | 
					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
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user