Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/getting-started: point out where to run make #20336

Merged
merged 2 commits into from
Feb 5, 2024
Merged

doc/getting-started: point out where to run make #20336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57ecb89
doc/getting-started: point out where to run `make`
maribu Feb 4, 2024
8ea106c
build system: add tl;dr to error message
maribu Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ""
Expand All @@ -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=<INSERT_BOARD_NAME>"
7 changes: 3 additions & 4 deletions doc/doxygen/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading