added README
This commit is contained in:
		
							parent
							
								
									ae6f0ff9d8
								
							
						
					
					
						commit
						8575d51440
					
				
					 1 changed files with 29 additions and 0 deletions
				
			
		
							
								
								
									
										29
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,29 @@
 | 
				
			||||||
 | 
					# Tutu
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Tutu is a comfortable experience for tooting. Designed to work on any device - desktop, phone and tablet.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Compatibility
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The code is built against those targets and Tutu must run on those platforms:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					| Firefox | Safari |  iOS  | Chrome | Edge |
 | 
				
			||||||
 | 
					| ------- | ------ | ----- | ------ | ---- |
 | 
				
			||||||
 | 
					|   98    |  15.4  | 15.4  |   84   |  87  |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Tutu trys to push the Web technology to its limit. Some features might not be available on the platform does not meet the requirement.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Build & Depoly
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Tutu uses [bun](https://bun.sh) as the package manager. Run
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					````sh
 | 
				
			||||||
 | 
					bun install && bun dist
 | 
				
			||||||
 | 
					````
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					to build the distribution, saved at "dist" directory.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Tutu must be loaded in a secure context - that means serving under localhost (`127.0.0.1` or `::1`) or HTTPS.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Use `bun dev` to run the dev server. By default, the dev server is run on the domain <https://localhost.direct> and the port you defined. The cert is provided by localhost.direct, see <https://get.localhost.direct> for detail.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can also change the config to make it run on localhost - but localhost.direct can be visted from the other device on the same network (as you do a little DNS magic).
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue