-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created README for the landing page (#71)
* Updated README Added, - Introduction - How to install and play - Contribution guidelines
- Loading branch information
Showing
1 changed file
with
43 additions
and
1 deletion.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,5 +1,47 @@ | ||
# cli-games | ||
# CLI Games | ||
> Games in the terminal | ||
[![Run on Repl.it](https://repl.it/badge/github/salifm/cli-games)](https://repl.it/@AllAwesome497/cli-games) | ||
|
||
CLI Games is a community-driven collection of games that could be run in your terminal! Currently this project has many games including, | ||
- Hangman | ||
- Maze Escape | ||
- Text Adventures | ||
- Tic-Tac-Toe | ||
|
||
*And more in the future!* | ||
|
||
# How to Install? | ||
|
||
Installation is very simple. | ||
|
||
```bash | ||
#Clone the repo | ||
git clone https://github.com/salifm/cli-games.git | ||
cd cli-games | ||
``` | ||
|
||
# How to Play? | ||
|
||
After cloning, run `ls` *(or `dir` on Windows)* to get a list of available directories of games. Then navigate to your favourite game using the `cd` command | ||
|
||
**Eg:** `cd Hangman` | ||
|
||
Read the **README** file in the respective directory to get more instruction about installation and playing. | ||
Most of the games support different languages (including `node-js` and `python`) and the choice is yours! | ||
|
||
# Contributing | ||
|
||
Want to contribute this project? We are happy to accept your contributions! You can do the following to contribute us | ||
|
||
- Making / Implementing suggestions and new features | ||
- Creating / Fixing bug reports | ||
- Improving the performance | ||
- [Creating new games](#creating-new-games) | ||
- Spreading the word! | ||
|
||
## Creating new games | ||
|
||
Before creating a new game, please check if it is available already, or somebody is working on creating that game. Then make sure to create a new issue to make sure others are OK with it. If you got approval for your suggestion, then move one! Code your game and create a PR with the new changes. We'll be happy to introduce your new game :smile: | ||
|
||
**This project is driven on community basis. So we are happy to accept your contributions a lot!** |