Skip to content

Commit

Permalink
Edited readme
Browse files Browse the repository at this point in the history
  • Loading branch information
squee72564 committed Jan 5, 2024
1 parent 80fb288 commit b73db9b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions scenes/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
This README should have a more detailed explanation on the 3 files used to automate the scene FP arrays and enumeration.
# IMPORTANT INFO

- How can the user add additional scenes?
- What files new are necessary and what modifications are necessary for existing files?
This scene directory has 3 important files in addition to other scene specific files:

- Maybe an explanation of the use of ADD_SCENE(...) macro and example of what it produces?
1. [minesweeper_scene.c](https://github.com/squee72564/F0_Minesweeper_Fap/blob/main/scenes/minesweeper_scene.c)
- File generates on_enter/exit/event handler fp arrays for Scene Manager and Initializes Scene Handlers configuration structure
2. [minesweeper_scene.h](https://github.com/squee72564/F0_Minesweeper_Fap/blob/main/scenes/minesweeper_scene.h)
- File generates on_enter/exit/event handler function declarations for all scenes
- Generates Enum for all scenes
3. [minesweeper_scene_config.h](https://github.com/squee72564/F0_Minesweeper_Fap/blob/main/scenes/minesweeper_scene_config.h)
- Macro definition of ADD_SCENE() for each scene used.
- When adding new scenes you need to add a new macro definition to this file, along with the appropriate .c file for the definitions of the on_event/enter/exit functions for the scene.

0 comments on commit b73db9b

Please sign in to comment.