1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-17 18:43:50 +01:00

31 Commits

Author SHA1 Message Date
AnnsAnn
859bf359e6 doc/doxygen: mark deprecated files in title 2025-09-18 15:37:50 +02:00
AnnsAnn
3eda07e63d doc: move architecture dependencies into starlight guide
fix: add note when sections will be removed
2025-07-21 22:19:59 +02:00
AnnsAnn
bf6e7a0896 doc: Deprecate doxygen guides and sync changes 2025-07-21 22:19:59 +02:00
crasbe
2e052cfc45 doc/getting-started: fix links, minor cleanup 2025-05-08 17:38:48 +02:00
Joshua DeWeese
b0365ecf84 doc: add psutil requirement to Getting Started
This patch adds the missing required psutil package to the getting
started guide. This requirement was introduced in commit
0de3b8a7d8ad68371669ac769810ba7bd0a2ee0c.
2025-04-11 22:43:02 -04:00
crasbe
7543be5441 buildsystem: Remove unused scripts and update docker docs 2025-04-05 21:59:43 +02:00
Mikolai Gütschow
9a45c30222
examples: shorten subfolders' names 2025-02-21 09:55:24 +01:00
Mikolai Gütschow
ca5fe72bf8
treewide: fix example references in docs
adapt to folder structure from #21135
2025-02-14 19:14:22 +01:00
Mikolai Gütschow
e6fb623947
doc/getting-started: add hint for correct access rights on serial device 2024-04-19 17:31:31 +02:00
Marian Buschsieweke
dc901b0e62
doc/doxygen/src/getting-started.md: fix broken link 2024-03-19 12:54:50 +01:00
Marian Buschsieweke
8b088c8d4a
doc: Add guide for dev setup on Windows
This adds a step-by-step guide to install a dev setup based on
WSL2 / Ubuntu and native VS Code with the WSL extension. The guide
uses screenshots and adds annotations on top using Inkscape, so that
every click is documented.

The Inkscape sources are also added to allow adjusting / fixing the
annotations later on without having to record a new set of screenshots.

Co-authored-by: Dylan Laduranty <dylan.laduranty@mesotic.com>
2024-02-28 10:18:39 +01:00
Marian Buschsieweke
57ecb896ec
doc/getting-started: point out where to run make 2024-02-04 17:54:02 +01:00
Teufelchen1
35a06c4806 boards/native: Remove macOS as native target 2022-10-25 19:11:23 +02:00
MrKevinWeiss
6cad5d2477
cpu/mips: Remove all mips 2022-09-27 13:42:37 +02:00
chrysn
95c540058d doc/getting-started: Add C++ standard library to the list 2022-09-20 16:42:19 +02:00
Alf Sebastian Houge
58dfe0315e Change git clone protocol to https in docs 2022-08-30 13:13:25 +02:00
Teufelchen1
1231807bab Documentation: Renaming OS X to macOS 2022-06-23 17:25:48 +02:00
Francisco Molina
822bef48da doc/doxygen: add BUILD_IN_DOCKER extended doc 2022-03-18 07:57:50 +01:00
Gunar Schorcht
4220f65bf8 doc: remove backticks from headings in "Getting Started"
Backticks in headings no longer seem to work in doxygen markdown support.
2022-03-06 23:41:28 +01:00
Gunar Schorcht
d1fd11c2f5 doc: fix "Getting Started" structure for section docker
Fixes two problems:
- Section "Usage" which describes the usage of docker is on heading level 1 but has to be on  heading level 2
- Section "Setup" has only one subsection. A second subsection was added. Now, the section "Setup" has two subsections, one that describes the installation of docker and one that describes downloading and testing of the RIOT docker build image.
2022-03-06 23:41:28 +01:00
Jnae
5bb4d29aed doc/getting-started.md: added beginner friendly instructions 2021-10-27 08:15:42 +02:00
Marian Buschsieweke
ba859613d4
doc/.../getting-started.md: update software requirements 2021-10-19 11:26:42 +02:00
Marian Buschsieweke
a07dac9ad1
build system: add new compile-commands make target
By running make compile-commands a `compile_commands.json` in the RIOT base
directory. With the environment variable `COMPILE_COMMANDS` the path of
this file can be changed to a custom location.

The `compile_commands.json` will contain the exact compile command, but
as additional flag `-I/usr/$(TARGET)/include` is added to work around
`clangd` not being able to locate the newlib system headers. The
additional includes can be overwritten using the environment variable
`COMPILE_COMMANDS_EXTRA_INCLUDES`.
2021-04-14 14:51:46 +02:00
Leandro Lanzieri
79fe7274ca
doc: add documentation on default configurations 2021-03-10 14:18:09 +01:00
Koen Zandberg
5281a1b155
doc: add Docker info to doxygen 2020-11-13 11:50:50 +01:00
Alexandre Abadie
b5b3491726
doc: add tapsetup note in getting-started page 2020-10-03 16:03:05 +02:00
Leandro Lanzieri
efea82eb7a doc: Add section on configuration in 'getting started' page 2020-02-05 15:51:55 +01:00
Alexandre Abadie
43c2b3201d doc/doxygen: fix typo in getting started page 2018-10-05 09:48:02 +02:00
Martine Lenders
29842bb5e4 netdev2: rename to netdev and remove gnrc_netdev
With some minor hand-edits I used the following chain of commands:

```sh
git rm sys/include/net/gnrc/netdev.h
git grep --name-only -i netdev2 | \
        xargs sed -i -e 's/^\(NETDEV\)2\(.*\)\( [("]\)/\1\2 \3/g' \
                     -e 's/\(netdev\)2\(.*\)\( \/\*\*<\)/\1\2 \3/I' \
                     -e 's/\(netdev\)2/\1/gI'
git add -p
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
        grep "netdev2" | xargs -I'{}' dirname '{}' | uniq | \
        grep "netdev2" | while read dir; do
                new_dir="$(echo "$dir" | sed "s/netdev2/netdev/g")"
                git mv -f "$dir" "$new_dir"
        done
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
        grep "netdev2" | while read file; do
                new_file="$(echo "$file" | sed "s/netdev2/netdev/g")"
                git mv -f "$file" "$new_file"
        done
git commit --amend
git grep --name-only "\<drivers_netdev_netdev\>" | \
        xargs sed -i "s/\<drivers_netdev_netdev\>/drivers_netdev_api/g"
git add -p
git commit --amend
```
2017-03-15 09:31:20 +01:00
Martine Lenders
8c52d3e364 doc: fix typo 2016-04-08 16:08:40 +02:00
Martine Lenders
ccab1eae82 doc: add 'Getting started' page 2015-11-19 10:20:41 +01:00