Skip to content

Commit

Permalink
Test mermaid
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Aug 1, 2024
1 parent c0cc8e1 commit 2ea2e5c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,6 @@ 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.

## Footnotes

- [1] 'book' is an overstatement for now: it is just a collection of notes
- [2] There is no chapter numbering yet

## 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/)
28 changes: 28 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
# Welcome to 'Developing Bevy games using TDD'

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

![](assets/ferris.png)

```mermaid
flowchart TD
introduction[1. Introduction]
hello_world[2.1. hello_world\nGet started]
add_player[2.2. add_player\nAdd a player]
add_player_sprite[2.3. add_player_sprite\nAdd a player sprite]
add_player_sprite_with_texture[2.4. add_player_sprite_with_texture\nAdd a player sprite\nwith a texture]
add_camera[2.5. add_camera\nAdd a camara]
move_player[2.6. move_player\nMove the player]
add_text[2.7. add_text\nAdd text]
introduction -.-> hello_world
hello_world --> add_player
add_player --> add_player_sprite
add_player_sprite --> add_player_sprite_with_texture
add_player_sprite_with_texture --> add_text
add_player_sprite_with_texture --> add_camera
add_player_sprite --> move_player
```

## Footnotes

- [1] 'book' is an overstatement for now: it is just a collection of notes

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ repo_url: https://github.com/richelbilderbeek/bevy_tdd_book

nav:
- Home: index.md
- Introduction:
- 1. Introduction: introduction/introduction.md
- Basic:
- 2.1. Hello world: chapters/hello_world.md
Expand Down

0 comments on commit 2ea2e5c

Please sign in to comment.