mirror of
https://github.com/FranP-code/Rock-Paper-and-Scissors-CLI-Game.git
synced 2025-10-13 00:32:38 +00:00
readme addded
This commit is contained in:
46
readme.md
Normal file
46
readme.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# Rock, Paper and Scissors CLI Game
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
This is a rock, paper and scissors game working in console.
|
||||||
|
|
||||||
|
It work on Linux and (it is assumed) on Windows.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- Git
|
||||||
|
- npm
|
||||||
|
- Inquirer.js
|
||||||
|
- colors.js
|
||||||
|
|
||||||
|
### How install?
|
||||||
|
|
||||||
|
- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
|
||||||
|
- [npm](https://nodejs.org/en/download/)
|
||||||
|
- [Inquirer.js](https://www.npmjs.com/package/inquirer)
|
||||||
|
- [colors.js](https://www.npmjs.com/package/colors)
|
||||||
|
|
||||||
|
## Play game
|
||||||
|
|
||||||
|
1. Clone the repo.
|
||||||
|
```
|
||||||
|
git clone https://github.com/FranP-code/Rock-Paper-and-Scissors-CLI-Game.git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Go to the project folder
|
||||||
|
```
|
||||||
|
cd ./Rock-Paper-and-Scissors-CLI-Game
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Run it
|
||||||
|
```
|
||||||
|
node ./index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
or...
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run game
|
||||||
|
```
|
||||||
|
|
||||||
|
I hope you enjoy it! 🙌
|
||||||
Reference in New Issue
Block a user