Skip to content

Commit

Permalink
Fix scripts, package-lock.json, LICENSE.txt, README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
salif committed Oct 10, 2023
1 parent fac9fd7 commit 8c6ffec
Show file tree
Hide file tree
Showing 8 changed files with 142 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,8 @@ indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true

[*.sh]
indent_style = tab
indent_size = 4
insert_final_newline = true
0 LICENSE → LICENSE.txt
100755 → 100644
File renamed without changes.
41 changes: 41 additions & 0 deletions MazeEscape/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions README.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ CLI Games is a community-driven collection of games that could be run in your te

*And more in the future!*

# How to Install?
## How to Install?

Installation is very simple.

Expand All @@ -25,8 +25,10 @@ cd cli-games
bash install-games.sh
```

# How to Play?
### for windows
## How to Play?

### for Windows

After cloning, run `dir` to get a list of available directories of games. Then navigate to your favourite game using the `cd` command

**Eg:** `cd Hangman`
Expand All @@ -35,13 +37,14 @@ Read the **README** file in the respective directory to get more instruction abo
Most of the games support different languages (including `node-js` and `python`) and the choice is yours!

### for Unix/Linux

just type
```sh
```bash
bash games.sh
```
and select the game by the number or 'e' for exit. If a game has a JS and Python version, you can choose which one you prefer you to play

# Contributing
## Contributing

Want to contribute this project? We are happy to accept your contributions! You can do the following to contribute us

Expand All @@ -51,7 +54,7 @@ Want to contribute this project? We are happy to accept your contributions! You
- [Creating new games](#creating-new-games)
- Spreading the word!

## Creating new games
### 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:

Expand Down
42 changes: 42 additions & 0 deletions Snake/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 41 additions & 0 deletions TextAdventures/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions games.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ case $option in
read game
case $game in
"js"|"JS"|"Js"|"jS"|"Javascript"|"javascript")
cd $dir/Hangman && node hangman.js
cd $dir/Hangman && node index.js
;;
"py"|"python"|"PY"|"Python")
cd $dir/Hangman && python3 hangman.py
Expand Down Expand Up @@ -51,7 +51,7 @@ case $option in
read tictactoe
case $tictactoe in
"js"|"JS"|"Js"|"jS"|"Javascript"|"javascript"|"j")
cd $dir/TicTacToe && node tictactoe.js
cd $dir/TicTacToe && node index.js
;;
"py"|"python"|"PY"|"Python"|"p")
cd $dir/TicTacToe && python tictactoe.py
Expand Down
4 changes: 2 additions & 2 deletions install-games.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ text_not_installed="dependencies not installed, please refer the problem log abo


printf "Installing Hangman dependencies... \n"
pip install pyfiglet lolcat
pip install -r requirements.txt


printf "Installing MazeEscape dependencies... \n"
Expand Down Expand Up @@ -39,5 +39,5 @@ else
exit 1
fi

printf "Dependences installed succesfully"
printf "Dependences installed succesfully\n"
exit 0

0 comments on commit 8c6ffec

Please sign in to comment.