kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-24 22:13:52 +01:00
Code Releases Activity

Merge pull request #11247 from MrKevinWeiss/pr/tests/doc

Browse Source 
tests/doc: Add intial how to test doc
This commit is contained in:
Gaëtan Harter 2019-03-24 15:59:19 +01:00 committed by GitHub
commit 6bbd3a5c27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxygen/riot.doxyfile
View File

@ -765,6 +765,7 @@ INPUT = ../../doc.txt \
src/creating-modules.md \
src/creating-an-application.md \
src/getting-started.md \
../../tests/README.md \
src/advanced-build-system-tricks.md \
src/changelog.md \
../../LOSTANDFOUND.md

22
tests/README.md Normal file
View File

@ -0,0 +1,22 @@
Running and creating tests {#running-and-creating-tests}
==========================
There are a number of tests included in RIOT. They are located in the
[tests folder](https://github.com/RIOT-OS/RIOT/tree/master/tests). These tests
allow basic functionality to be verified as well as provide an example of
usage.
Running automated tests
-----------------------
Some tests can be performed automatically. The test automation scripts are
defined in the `<test_application>/tests/` folder. They are written in python
and interact through the uart with the test application code running on a
board to do the validation. It is recommended to flash the board with the
test just before running it because some platforms cannot be reset while
testing.
From the test application directory run:
BOARD=<board_of_your_choice> make flash test