Skip to content

Commit

Permalink
doc: Add guide for dev setup on Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
@maribu
maribu committed Feb 28, 2024
1 parent 0b385c6 commit 9044471
Show file tree
Hide file tree
Showing 77 changed files with 2,997 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,11 @@ For specific toolchain installation, follow instructions in the
version of the documentation is uploaded daily to
[doc.riot-os.org](https://doc.riot-os.org).

Using Windows? Use [this guide][dev-setup-windows] to
[setup the development environment][dev-setup-windows].

[dev-setup-windows]: doc/guides/setup-windows

## Forum
Do you have a question, want to discuss a new feature, or just want to present
your latest project using RIOT? Come over to our [forum] and post to your hearts
Expand Down
7 changes: 6 additions & 1 deletion doc/doxygen/src/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ will also be fine - however, we rely on users to report bugs regarding tooling i
here. So expect occasional issues for the development branch and please help testing during the
feature freeze period, if you develop on macOS or BSD.

Native development on Windows and macOS machines is not officially supported. What works well is using Linux
Windows users can refer to [this guide][dev-setup-windows] to
[setup the development enviroment][dev-setup-windows] on Windows.

Check failure on line 38 in doc/doxygen/src/getting-started.md

View workflow job for this annotation

GitHub Actions / static-tests 

There is a typo: enviroment ==> environment

If this is a false positive, add it to dist/tools/codespell/ignored_words.txt.

You can fix this interactively by calling

     CODESPELL_INTERACTIVE=1 BASE_BRANCH=master ./dist/tools/codespell/check.sh

[dev-setup-windows]: doc/guides/setup-windows

Native development on macOS machines is not officially supported. What works well is using Linux
in a virtual machine, but at much lower performance than running Linux natively. We also offer Docker images.
For development on Windows, using the
[Windows Subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
Expand Down
Loading

0 comments on commit 9044471

Please sign in to comment.