From f5e11f1b64a1e0530a387f352f001b4767749a3a Mon Sep 17 00:00:00 2001 From: Seniru Pasan Indira Date: Mon, 16 Dec 2019 15:50:47 +0530 Subject: [PATCH] Created README for the landing page (#71) * Updated README Added, - Introduction - How to install and play - Contribution guidelines --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 41bf006..1cbc0bb 100644 --- a/README.md +++ b/README.md @@ -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!**