Skip to content

Commit

Permalink
EOD
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Oct 16, 2024
1 parent ded1193 commit 8e20762
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# bevy_tdd_book

<!-- markdownlint-disable MD013 -->

[![Check chapters](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_chapters.yaml/badge.svg?branch=master)](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_chapters.yaml)
[![Check links](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_links.yaml/badge.svg?branch=master)](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_links.yaml)
[![Check markdown](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_markdown.yaml/badge.svg?branch=master)](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_markdown.yaml)
[![Check spelling](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_spelling.yaml/badge.svg?branch=master)](https://github.com/richelbilderbeek/bevy_tdd_book/actions/workflows/check_spelling.yaml)

<!-- markdownlint-enable MD013 -->

Start of a book [1] called 'Developing Bevy games using TDD'.
The goal is to demonstrate how to do Test-Driven Development with Bevy.

Expand All @@ -22,6 +26,8 @@ The goal is to demonstrate how to do Test-Driven Development with Bevy.

- [2.1. Introduction](docs/misc/basic_introduction.md)

<!-- markdownlint-disable MD013 -->

Code |Code coverage |Chapter |Description |Concepts
----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------|------------------
[code](https://github.com/richelbilderbeek/bevy_tdd_book_hello_world) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_hello_world/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_hello_world) |[hello_world.md](docs/chapters/hello_world.md) |Hello world |A minimal `App`
Expand All @@ -32,10 +38,14 @@ Code
[code](https://github.com/richelbilderbeek/bevy_tdd_book_add_camera) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_add_camera/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_add_camera) |[add_camera.md](docs/chapters/add_camera.md) |Adding a camera |Using `Camera2dBundle`
[code](https://github.com/richelbilderbeek/bevy_tdd_book_move_player) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_player/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_player) |[move_player.md](docs/chapters/move_player.md) |Move the player |Extending a Component

<!-- markdownlint-enable MD013 -->

### Section 3: user input

- [3.1. Introduction](docs/misc/respond_to_input_introduction.md)

<!-- markdownlint-disable MD013 -->

Code |Code coverage |Chapter |Description |Concepts
----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------|------------------
[code](https://github.com/richelbilderbeek/bevy_tdd_book_respond_to_window_resize) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_window_resize/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_window_resize) |[respond_to_window_resize.md](docs/chapters/respond_to_window_resize.md) |Respond to window resize, minimal example|Minimal example, mouse wheel press
Expand All @@ -46,6 +56,8 @@ Code
[code](https://github.com/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_turn) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_turn/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_turn) |[respond_to_mouse_wheel_turn.md](docs/chapters/respond_to_mouse_wheel_turn.md) |Respond to mouse, minimal example |Minimal example, mouse wheel turn
[code](https://github.com/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_press) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_press/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_respond_to_mouse_wheel_press) |[respond_to_mouse_wheel_press.md](docs/chapters/respond_to_mouse_wheel_press.md) |Respond to mouse, minimal example |Minimal example, mouse wheel press

<!-- markdownlint-enable MD013 -->

- gamepad


Expand All @@ -64,15 +76,21 @@ Code

### Section for possible chapters

<!-- markdownlint-disable MD013 -->

Code |Code coverage |Chapter |Description |Concepts
----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------|------------------
[code](https://github.com/richelbilderbeek/bevy_tdd_book_use_game_state) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_game_state/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_game_state) |. |Use Bevy states |Minimal example, state, States
[code](https://github.com/richelbilderbeek/bevy_tdd_book_use_resources) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_resources/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_resources) |. |Use Bevy resources |Minimal example, resources
[code](https://github.com/richelbilderbeek/bevy_tdd_book_use_window_title) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_window_title/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_use_window_title) |. |Get and set a window's title |Minimal example, window title
[code](https://github.com/richelbilderbeek/bevy_tdd_book_click_sprite) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_click_sprite/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_click_sprite) |. |Click on a sprite |Minimal example, sprite, mouse click, interaction

<!-- markdownlint-enable MD013 -->

### Appendix

<!-- markdownlint-disable MD013 -->

Code |Code coverage |Chapter [2] |Description |Concepts
----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------|------------------
[code](https://github.com/richelbilderbeek/bevy_tdd_book_move_camera) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_camera/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_camera) |[move_camera.md](docs/chapters/move_camera.md) |Move the camera |Extending a Component
Expand All @@ -82,8 +100,12 @@ Code
[code](https://github.com/richelbilderbeek/bevy_tdd_book_move_player_with_mouse) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_player_with_mouse/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_move_player_with_mouse) |[move_player_with_mouse.md](docs/chapters/move_player_with_mouse.md) |Respond to mouse |.
[code](https://github.com/richelbilderbeek/bevy_tdd_book_show_2d_coordinate_systems) |[![codecov](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_show_2d_coordinate_systems/graph/badge.svg?token=XAVFZYDQKZ)](https://codecov.io/gh/richelbilderbeek/bevy_tdd_book_show_2d_coordinate_systems) |[show_2d_coordinate_systems.md](docs/chapters/show_2d_coordinate_systems.md) |Show 2D coordinate systems |2D coordinate systems

<!-- markdownlint-enable MD013 -->

## Files used by continuous integration scripts

<!-- markdownlint-disable MD013 -->

Filename |Descriptions
------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------
[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally
Expand All @@ -92,6 +114,8 @@ Filename |Descriptions
[.markdownlint.jsonc](.markdownlint.jsonc)|Configuration of the markdown linter, use `markdownlint "**/*.md"` to do markdown linting locally. The name of this file is a default name.
[.markdownlintignore](.markdownlintignore)|Files ignored by the markdown linter, use `markdownlint "**/*.md"` to do markdown linting locally. The name of this file is a default name.

<!-- markdownlint-enable MD013 -->

## Links

- [Blog post 'Test-Driven Development in Rust Game Development with Bevy' by Edgardo Carreras](https://edgardocarreras.com/blog/tdd-in-rust-game-engine-bevy/)
1 change: 1 addition & 0 deletions docs/misc/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
These are people and websites that helped me, in alphabetical order:

- [https://github.com/aldeka/rustacean.net](https://github.com/aldeka/rustacean.net) for providing [ferris.png](../assets/ferris.png) and [ferris.svg](../assets/ferris.svg)
- [Edgardo Carreras](https://github.com/donedgardo) for [his feedback on an early draft](https://github.com/richelbilderbeek/bevy_tdd_book/issues/8)
- [`inodentry`](https://github.com/inodentry) for starting [the Unofficial Bevy Cheat Book](https://github.com/bevy-cheatbook/bevy-cheatbook), as well as its contributors
- `kristoff3r`: answered a question on the Bevy Discord channel
- `mgi388`: answered a question on the Bevy Discord channel
Expand Down

0 comments on commit 8e20762

Please sign in to comment.