-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Make README markdown, add more info
- Loading branch information
Showing
2 changed files
with
83 additions
and
49 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
<div align="center"> | ||
<h2 align="center">gg</h2> | ||
<p align="center"> | ||
games you can play in your terminal! | ||
|
||
<br/> | ||
<br/> | ||
|
||
<a href="https://github.com/Kaamkiya/gg/issues/new">Report a bug or request a feature</a> | ||
|
||
</p> | ||
</div> | ||
|
||
## About The Project | ||
|
||
![A screenshot of 2048, dodger, and a maze running in separate windows.](assets/gameplay.png) | ||
|
||
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! | ||
|
||
And as a developer, that's perfect because half of my computer time is spent in a terminal. | ||
|
||
Enjoy playing terminal games :) | ||
|
||
### Built With | ||
|
||
- [Go](https://go.dev) | ||
- [Charm libraries](https://charm.sh) | ||
|
||
## Getting Started | ||
|
||
This section is about installation and usage. | ||
|
||
### Prerequisites | ||
|
||
- Go (optional) | ||
|
||
### Installation | ||
|
||
1. Installation with Go: | ||
``` | ||
go install github.com/Kaamkiya/gg@latest | ||
``` | ||
2. Running with Go: if you don't want to install it but still want to play | ||
``` | ||
go run github.com/Kaamkiya/gg@latest | ||
``` | ||
3. Release binary: | ||
* Go to the [releases page](https://github.com/Kaamkiya/gg/releases) | ||
* Download the one for your platform | ||
* Make it executable (`chmod +x ./<file>`) | ||
* Run it! | ||
|
||
## Usage | ||
|
||
Enter the command into the terminal: | ||
|
||
``` | ||
gg | ||
``` | ||
|
||
Then select a game and enjoy! | ||
|
||
## Contributing | ||
|
||
All sorts of contributions are welcome! | ||
|
||
To contribute: | ||
|
||
1. Fork the Project | ||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
5. Open a Pull Request | ||
|
||
## License | ||
|
||
Distributed under the Unlicense. See [Unlicense License](https://unlicense.org) for more information. | ||
|
||
## Acknowledgments | ||
|
||
|
||
- [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/) | ||
|