Nicer readme, and refurbished the documentation
This commit is contained in:
		
							parent
							
								
									8282f8e0dd
								
							
						
					
					
						commit
						48a746b313
					
				
							
								
								
									
										13
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										13
									
								
								README.md
									
									
									
									
									
								
							|  | @ -1,11 +1,22 @@ | ||||||
| # hellocomputer | # hellocomputer | ||||||
| 
 | 
 | ||||||
| Analytics with natural language | [Hello, computer!](https://youtu.be/hShY6xZWVGE?si=pzJjmc492uLV63z-) | ||||||
|  | 
 | ||||||
|  | `hellocomputer` is a GenAI-powered web application that allows you to analyze spreadsheets  | ||||||
|  | 
 | ||||||
|  |  | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ## Quick install and run | ||||||
|  | 
 | ||||||
|  | If you have `uv` installed, just clone the repository and run: | ||||||
| 
 | 
 | ||||||
| ``` | ``` | ||||||
| uv pip install -r requirements.in | uv pip install -r requirements.in | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | And to get the application up and running... | ||||||
|  | 
 | ||||||
| ``` | ``` | ||||||
| uvicorn hellocomputer.main:app --host localhost | uvicorn hellocomputer.main:app --host localhost | ||||||
| ``` | ``` | ||||||
							
								
								
									
										
											BIN
										
									
								
								docs/img/gui_v01.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/img/gui_v01.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 269 KiB | 
		Loading…
	
		Reference in a new issue