Add readme
This commit is contained in:
		
							
								
								
									
										22
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,22 @@
 | 
				
			|||||||
 | 
					# Minecraft Bot
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Setup
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Assuming Debian / Ubuntu based distro:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					$ sudo apt update
 | 
				
			||||||
 | 
					$ sudo apt install build-essential python3 python3-dev python3-pip python-virtualenv python3-virtualenv
 | 
				
			||||||
 | 
					$ virtualenv -p python3 env
 | 
				
			||||||
 | 
					$ source env/bin/activate
 | 
				
			||||||
 | 
					(env) $ pip install -r requirements.txt
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Always make sure the virtual environment is running `(env)`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Running
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					(env) $ USERNAME=you@domain.com PASSWORD=supersecret SERVER=example.com python main.py
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
		Reference in New Issue
	
	Block a user