From 57ecb896eca705b61b1e4c55e427bc8fb854dddf Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Sun, 4 Feb 2024 17:54:02 +0100 Subject: [PATCH 1/2] doc/getting-started: point out where to run `make` --- doc/doxygen/src/getting-started.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/doxygen/src/getting-started.md b/doc/doxygen/src/getting-started.md index 081aa8bcd8e4..1b6579117eed 100644 --- a/doc/doxygen/src/getting-started.md +++ b/doc/doxygen/src/getting-started.md @@ -202,7 +202,8 @@ Building and executing an example {#building-and-executing-an-example} --------------------------------- RIOT provides a number of examples in the `examples/` directory. Every example has a README that documents its usage and its purpose. You can build them by -typing +opening a shell, navigating to an example (e.g. `examples/default`), and +running: ~~~~~~~~ {.sh} make BOARD=samr21-xpro @@ -214,9 +215,7 @@ or make all BOARD=samr21-xpro ~~~~~~~~ -into your shell. - -To flash the application to a board just type +To flash the application to a board just run: ~~~~~~~~ {.sh} make flash BOARD=samr21-xpro From 8ea106c16e54e6e50460e404e0e4abc7e87a60b1 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Sun, 4 Feb 2024 19:41:32 +0100 Subject: [PATCH 2/2] build system: add tl;dr to error message When running `make` in the root directory, it might be best to just add as tl;dr section at the bottom. --- Makefile | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index ea0426fb52c0..d42a1f2718b7 100644 --- a/Makefile +++ b/Makefile @@ -30,6 +30,17 @@ distclean: docclean pkg-clean @echo "Cleaning all build products" @for dir in $(APPLICATION_DIRS); do "$(MAKE)" -C$$dir distclean; done +print-versions: + @./dist/tools/ci/print_toolchain_versions.sh + +include makefiles/boards.inc.mk +include makefiles/app_dirs.inc.mk + +include makefiles/tools/riotgen.inc.mk +-include makefiles/tests.inc.mk + +include makefiles/color.inc.mk + welcome: @echo "Welcome to RIOT - The friendly OS for IoT!" @echo "" @@ -47,12 +58,7 @@ welcome: @echo " print-versions" @echo " clean distclean pkg-clean" @echo " doc doc-{man,latex}" - -print-versions: - @./dist/tools/ci/print_toolchain_versions.sh - -include makefiles/boards.inc.mk -include makefiles/app_dirs.inc.mk - -include makefiles/tools/riotgen.inc.mk --include makefiles/tests.inc.mk + @echo "" + @echo "==> tl;dr Try running:" + @echo " cd examples/default" + @echo " make BOARD="