Skip to content

Commit

Permalink
minor documentation changess
Browse files Browse the repository at this point in the history
  • Loading branch information
kj3moraes committed Oct 13, 2023
1 parent 76e496d commit 6c15e8b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
19 changes: 19 additions & 0 deletions GAMES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Games Available

## Playable

The playable games right now are:

1. Breakout
2. Space Invaders
3. Pong

## Work in Progress

1. Frogger
2. Asteroids

## To be developed

1. Adventure
2. Pitfall
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ A fully featured terminal-based arcade built in Rust. Play games like

- Space Invaders
- Breakout
- Adventure
- Pong
etc.

The full list of games can be found in the `games/GAMES.md` file and the `games` folder. I would love for you to develop and add your own ports of Atari 2600 games.
The full list of games can be found in the `GAMES.md` file and the `src/games` folder. I would love for you to develop and add your own ports of Atari 2600 games.

This project is still in its early stages, so expect bugs and missing features.

Expand All @@ -29,4 +29,8 @@ For more information on this, refer to the HOWTO file.

## Documentation

The documentation on the crate and the development process can be found [here](). Refer to the `docs` folder for more information.
The documentation on the crate and the development process can be found [here](). Refer to the `docs` folder for more information.

## What is the motivation behind this project ?

These were developed in an effort to not have to scour the Internet for some fun games to play in the terminal. All the games that you desire is here in one arcade - Rusticade. There is still a way to go with developing and polishing the UI for some of the games.
Empty file removed src/games/GAMES.md
Empty file.

0 comments on commit 6c15e8b

Please sign in to comment.