Skip to content

Commit

Permalink
Docs: Actualizo el readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brunograssano committed Dec 18, 2020
1 parent 83a8789 commit a4252e0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
# Conway's-Game-of-Life
# Conway's Game of Life


## Build instructions
To build the project just use
To build the project use
```
cargo build
```

## Run instructions
To run the project you can do
To run the project you can use
```
cargo run [options]
```
**[options]**

You can run the program with the following options, the order in the command line doesn't matter
* colorful, c ----- The cells will appear with random colors
* random, r ----- The game will start with a random state

[TODO] read from file

Without options the game will start in default settings (empty board and black cells)
You can run the program with the following options, the order of the arguments doesn't matter
```
* colorful, c ----- The cells will appear with random colors
* random, r ----- The game will start with a random state
* no_padding, p ----- Disables the padding of the cells
```
Without options the game will start in default settings (empty board, black cells with padding)

Example
```
cargo run colorful r no_padding
```

## Game
Once the game starts, you can click the cells you want to activate. When you are ready,
you can start the game with ```return``` and pause it with ```p```.
While the simulation is running you can still activate cells (though they may disappear soon if alone).
Also, you can zoom in with the mouse wheel. If you want to move while zoomed in, you can do so with the keyboard arrows.
You can restart the game at any moment with ```r```.

## Implementation
The game was made entirely with Rust using Piston. This is the first project for me in Rust, so if you have any suggestions feel free to give feedback.
This is the first project for me in Rust, so please feel free to provide feedback.

The game was made entirely with Rust using Piston.

## License
This project is under the MIT License
Expand All @@ -41,3 +47,4 @@ This project is under the MIT License
![HelloWorldRunning](resources/HelloWorldRunning.PNG)
![ColorfulAndRandom](resources/ColorfulAndRandom.PNG)
![ColorfulAndRandomRunning](resources/ColorfulAndRandomRunning.PNG)
![NoPaddingAndZoom](resources/NoPaddingAndZoom.PNG)
Binary file added resources/NoPaddingAndZoom.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4252e0

Please sign in to comment.