added basic setup instructions
This commit is contained in:
		
							parent
							
								
									8fa61fe356
								
							
						
					
					
						commit
						d70601e7e3
					
				
					 1 changed files with 6 additions and 0 deletions
				
			
		
							
								
								
									
										6
									
								
								SETUP.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								SETUP.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,6 @@
 | 
				
			||||||
 | 
					# Setup Guide
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Set up python3 venv using `python3 -m venv /path/to/new/virtual/environment && source <venv>/bin/activate` (this should be in your local copy of the repository)
 | 
				
			||||||
 | 
					2. Install python dependencies using `pip install -r requirements.txt`
 | 
				
			||||||
 | 
					3. Write udtconfig.yml. (Use udtconfig_template.yml as a base)
 | 
				
			||||||
 | 
					4. Run tool using `python3 main.py --help`
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue