|  | 
|  | 1 | +<div align="center"> | 
|  | 2 | +<h2 align="center">gg</h2> | 
|  | 3 | +<p align="center"> | 
|  | 4 | +games you can play in your terminal! | 
|  | 5 | + | 
|  | 6 | +<br/> | 
|  | 7 | +<br/> | 
|  | 8 | + | 
|  | 9 | +<a href="https://github.com/Kaamkiya/gg/issues/new">Report a bug or request a feature</a> | 
|  | 10 | + | 
|  | 11 | +</p> | 
|  | 12 | +</div> | 
|  | 13 | + | 
|  | 14 | +## About The Project | 
|  | 15 | + | 
|  | 16 | + | 
|  | 17 | + | 
|  | 18 | +I like to play video games, probably like you. But I prefer smaller, more minimal games. And I figured the best way to keep games minimal is to play them from the CLI! | 
|  | 19 | + | 
|  | 20 | +And as a developer, that's perfect because half of my computer time is spent in a terminal. | 
|  | 21 | + | 
|  | 22 | +Enjoy playing terminal games :) | 
|  | 23 | + | 
|  | 24 | +### Built With | 
|  | 25 | + | 
|  | 26 | +- [Go](https://go.dev) | 
|  | 27 | +- [Charm libraries](https://charm.sh) | 
|  | 28 | + | 
|  | 29 | +## Getting Started | 
|  | 30 | + | 
|  | 31 | +This section is about installation and usage. | 
|  | 32 | + | 
|  | 33 | +### Prerequisites | 
|  | 34 | + | 
|  | 35 | +- Go (optional) | 
|  | 36 | + | 
|  | 37 | +### Installation | 
|  | 38 | + | 
|  | 39 | +1. Installation with Go: | 
|  | 40 | +  ``` | 
|  | 41 | +  go install github.com/Kaamkiya/gg@latest | 
|  | 42 | +  ``` | 
|  | 43 | +2. Running with Go: if you don't want to install it but still want to play | 
|  | 44 | +  ``` | 
|  | 45 | +  go run github.com/Kaamkiya/gg@latest | 
|  | 46 | +  ``` | 
|  | 47 | +3. Release binary: | 
|  | 48 | +  * Go to the [releases page](https://github.com/Kaamkiya/gg/releases) | 
|  | 49 | +  * Download the one for your platform | 
|  | 50 | +  * Make it executable (`chmod +x ./<file>`) | 
|  | 51 | +  * Run it! | 
|  | 52 | + | 
|  | 53 | +## Usage | 
|  | 54 | + | 
|  | 55 | +Enter the command into the terminal: | 
|  | 56 | + | 
|  | 57 | +``` | 
|  | 58 | +gg | 
|  | 59 | +``` | 
|  | 60 | + | 
|  | 61 | +Then select a game and enjoy! | 
|  | 62 | + | 
|  | 63 | +## Contributing | 
|  | 64 | + | 
|  | 65 | +All sorts of contributions are welcome! | 
|  | 66 | + | 
|  | 67 | +To contribute: | 
|  | 68 | + | 
|  | 69 | +1. Fork the Project | 
|  | 70 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | 
|  | 71 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | 
|  | 72 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) | 
|  | 73 | +5. Open a Pull Request | 
|  | 74 | + | 
|  | 75 | +## License | 
|  | 76 | + | 
|  | 77 | +Distributed under the Unlicense. See [Unlicense License](https://unlicense.org) for more information. | 
|  | 78 | + | 
|  | 79 | +## Acknowledgments | 
|  | 80 | + | 
|  | 81 | + | 
|  | 82 | +- [Al Sweigart's list of games to clone](https://inventwithpython.com/blog/2012/02/20/i-need-practice-programming-49-ideas-for-game-clones-to-code/) | 
|  | 83 | + | 
0 commit comments