79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| boards | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _microbit_pong: BBC micro:bit pong game ####################### Overview ******** Play pong over as single player or Bluetooth between two micro:bit devices. The game works by controlling a paddle with the two buttons of the micro:bit (labeled A and B). Initially the playing mode is selected: use button A to toggle between single- and multi-player, and press button B to select the current choice. To start the game, the player with the ball launches the ball by pressing both buttons. When multi-player mode has been selected the game will try to look for and connect to a second micro:bit which has also been set into multi- player mode. If the board has a piezo buzzer connected to pin 0, this will be used to generate beeps whenever the ball hits a wall or the paddle. Building and running ******************** .. zephyr-app-commands:: :zephyr-app: samples/boards/bbc_microbit/pong :board: bbc_microbit :goals: build flash :compact: