README: add simple readme file
Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
		
							
								
								
									
										15
									
								
								hw/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								hw/README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,15 @@
 | 
				
			|||||||
 | 
					# Foboot Firmware Component
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To build:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					`python3 .\foboot-bitstream.py`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This will ensure you have the required dependencies, and check out all submodules.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Tests
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can run tests by using the `unittest` command:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					`python .\lxbuildenv.py -r -m unittest -v valentyusb.usbcore.cpu.epfifo_test.TestPerEndpointFifoInterface`
 | 
				
			||||||
		Reference in New Issue
	
	Block a user