Skip to content

Commit

Permalink
update README file
Browse files Browse the repository at this point in the history
Signed-off-by: GuillaumeFalourd <[email protected]>
  • Loading branch information
GuillaumeFalourd committed Jun 6, 2021
2 parents 13b73f3 + c29ea32 commit 5a3877b
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,66 @@ This repository contains Ritchie formulas which can be executed by [ritchie-cli]

- [Ritchie CLI documentation](https://docs.ritchiecli.io)

## 📦 Use Formulas

To import this repository, you need [Ritchie CLI installed](https://docs.ritchiecli.io/getting-started/install-cli)

Then, you can use the `rit add repo` command manually, or execute the command line below directly on your terminal (since CLI version 2.8.0):

```bash
rit add repo --provider="Github" --name="formulas-games" --repoUrl="https://github.com/GuillaumeFalourd/formulas-games" --priority=1
```

Finally, you can check if the repository has been imported correctly by executing the `rit list repo` command.

## 🔎 What you'll find in this repository

- [Dino Run Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/dino-run): `rit game dino-run`

![Game](/docs/img/rit-game-dino-run-game.png)

* * *

- [Flappy Bird Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/flappy-bird): `rit game flappy-bird`

![Game](/docs/img/rit-game-flappy-bird-play.png)

* * *

- [Mario](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/mario): `rit game mario`

![Game](/docs/img/rit-game-mario-play.png)

* * *

- [Pacman Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/pacman): `rit game pacman`

![Game](/docs/img/rit-game-pacman-play.png)

* * *

- [Snake Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/snake): `rit game snake`

![Game](/docs/img/rit-game-snake-play.png)

* * *

- [Space Invasion Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/space-invasion): `rit game space-invasion`

![Game](/docs/img/rit-game-space-invasion-play.png)

* * *

- [Yahtzee Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/yahtzee): `rit game yahtzee`

![Game](/docs/img/rit-game-yahtzee-play.png)

* * *

- [Tetris Game](https://github.com/GuillaumeFalourd/formulas-python/tree/master/game/tetris): `rit game tetris`

![Game](/docs/img/rit-game-tetris-play.png)

## 📦 Use Formulas

To import this repository, you need [Ritchie CLI installed](https://docs.ritchiecli.io/getting-started/install-cli)

Then, you can use the `rit add repo` command manually, or execute the command line below directly on your terminal (since CLI version 2.8.0):

```bash
rit add repo --provider="Github" --name="formulas-games" --repoUrl="https://github.com/GuillaumeFalourd/formulas-games" --priority=1
```

Finally, you can check if the repository has been imported correctly by executing the `rit list repo` command.

## ♻️ Contribute to the repository

### 🆕 Creating formulas
Expand Down

0 comments on commit 5a3877b

Please sign in to comment.