Update README with some unix porn
This commit is contained in:
		
							parent
							
								
									6b24b54cb5
								
							
						
					
					
						commit
						ffa4a5b6b9
					
				
					 4 changed files with 36 additions and 8 deletions
				
			
		
							
								
								
									
										36
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										36
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -1 +1,37 @@
 | 
			
		|||
# tetris
 | 
			
		||||
 | 
			
		||||
A terminal interface for Tetris
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
## installation
 | 
			
		||||
 | 
			
		||||
For Mac and Linux, the binaries attached to the GitHub release should suffice.
 | 
			
		||||
Here is a quick way to get the one for your OS:
 | 
			
		||||
```bash
 | 
			
		||||
curl -L https://github.com/samtay/tetris/releases/download/0.1.0/tetris-`uname -s`-`uname-m` | sudo tee /usr/local/bin/tetris
 | 
			
		||||
sudo chmod +x /usr/local/bin/tetris
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
For Windows, you have to install from source. First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then
 | 
			
		||||
```bash
 | 
			
		||||
git clone https://github.com/samtay/tetris.git
 | 
			
		||||
cd tetris
 | 
			
		||||
stack install tetris
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## screenshots
 | 
			
		||||
 | 
			
		||||
#### Linux termite - tomorrow night eighties
 | 
			
		||||

 | 
			
		||||
#### Mac terminal - plain
 | 
			
		||||

 | 
			
		||||
#### Mac terminal - grass
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
## todo
 | 
			
		||||
 | 
			
		||||
1. Leaderboard saved to txt file (requires adding brick viewport for name entry)
 | 
			
		||||
and probably wrapping game in a ui state type
 | 
			
		||||
2. Use linear V2 instead of tuples.. dummy
 | 
			
		||||
3. Consider refactoring (Game -> a) types with State or Reader abstraction
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										
											BIN
										
									
								
								docs/img/linux_tomorrow_night_80s.png
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/img/linux_tomorrow_night_80s.png
									
										
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 23 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/img/play.gif
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/img/play.gif
									
										
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 73 KiB  | 
| 
						 | 
				
			
			@ -17,14 +17,6 @@ import Data.Bool (bool)
 | 
			
		|||
import Data.Maybe (fromMaybe)
 | 
			
		||||
import Data.Monoid (First(..))
 | 
			
		||||
 | 
			
		||||
-- TODO
 | 
			
		||||
--   1. leaderboard saved to txt file (requires adding viewport for name entry)
 | 
			
		||||
--      and probably wrapping game in a ui state
 | 
			
		||||
--   2. USE linear V2 instead of tuples.. dummy
 | 
			
		||||
--   3. Consider refactoring (Game -> a) with State or Reader abstraction
 | 
			
		||||
--   4. README with gif
 | 
			
		||||
--   5. release binaries for darwin and linux
 | 
			
		||||
 | 
			
		||||
-- Types and instances
 | 
			
		||||
 | 
			
		||||
-- | Tetris shape types
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue