Added readme
This commit is contained in:
		
							parent
							
								
									e5a9a5bce3
								
							
						
					
					
						commit
						20b1768bb1
					
				
							
								
								
									
										55
									
								
								README.md
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										55
									
								
								README.md
									
									
									
									
									
										Executable file
									
								
							| @ -0,0 +1,55 @@ | |||||||
|  | # hcatitles | ||||||
|  | This program will update the png file found at `D:\OBS Assets\Overlays\title.png` | ||||||
|  | 
 | ||||||
|  | ## Setting up the build environment | ||||||
|  | Making the assumption that python is installed in `C:\Program Files\Python39` and Develmpent is being done under `D:\Development` | ||||||
|  | 
 | ||||||
|  | Pull a copy of this project from gitN: | ||||||
|  | ``` | ||||||
|  | D:\ | ||||||
|  | cd \development | ||||||
|  | git clone https://git.elder-geek.net/Harvest/hcatitles.git | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | Then setup this foulder with a virtual environment: | ||||||
|  | ``` | ||||||
|  | cd hcatitles | ||||||
|  | & "C:\Program Files\Python39\python" -m venv venv | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | To activate the virtual enviroment when in the folder `D:\development\hcatiles`: | ||||||
|  | ``` | ||||||
|  | venv\Script\activate``` | ||||||
|  | 
 | ||||||
|  | Update `pip `and install requirments: | ||||||
|  | ``` | ||||||
|  | python -m pip install --upgrade pip | ||||||
|  | pip install -r requisments.txt | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | Testing code: | ||||||
|  | ``` | ||||||
|  | python hcatitiles.py | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | To create an executable in `D:\Development\hcatitles\dist`: | ||||||
|  | ``` | ||||||
|  | pyinstaller hcatitles.spec | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | When done working in the virtual enviroment: | ||||||
|  | ``` | ||||||
|  | deactivate | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ## First time run of pyinstaller to generate hcatitles.spec | ||||||
|  | Windows uses `^` to continues a commond on the next line. | ||||||
|  | ``` | ||||||
|  | pyinstaller --onefile --windowed --icon projector.ico ^ | ||||||
|  |             --add-data "blank_title.png:." ^ | ||||||
|  |             --add-data "tahoma.ttf:." ^ | ||||||
|  | 			--add-data "tahomabd.ttf:."  ^ | ||||||
|  | 			--add-data "projector.ico:." ^ | ||||||
|  | 			hcatitles.py | ||||||
|  |  ``` | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user