Skip to content

Commit

Permalink
add link to workflow, add linux distro info (#1438)
Browse files Browse the repository at this point in the history
  • Loading branch information
schluis authored Sep 13, 2024
1 parent dd84aa5 commit 45bbd6c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
11 changes: 11 additions & 0 deletions docs/setup/development_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

This section will guide you through the setup of your development environment to build software for the NAO robot and test your algorithms using our various tools.

## Operating System

At HULKs, we mainly use Linux for development.
If you're new to Linux, don't worry, at HULKs there are many people who can help you getting started.

??? info "Choosing the correct Linux Distribution"

![How-To-Chose-Os](./how_to_choose_os.jpg)

All joking aside, don't be persuaded to install Arch Linux, unless of course you want to delve into the depths of Linux and broaden your horizons.

## Installing Rust

We require a latest stable release of the Rust toolchain to build our tools.
Expand Down
3 changes: 3 additions & 0 deletions docs/setup/how_to_choose_os.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions docs/setup/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@

High-Level visualization of the Software Architecture: NAO, SDK, HULKs-Robotics code, Pepsi, etc.


This section describes the steps required to set up and get started with our framework.
The following pages include documentation to

- setup the [Development Environment](./development_environment.md),
- acquire or build the latest [NAO operating system image](./nao_image_and_sdk.md) and Software Development Toolkit (SDK) to cross-compile for the NAO,
- [setup the NAO](./nao_setup.md) by flashing the operating system image to the NAO,
- and [compile, upload, and run](./upload.md) the HULKs robotics software on the robot
- setup the [Development Environment](./development_environment.md),
- acquire or build the latest [NAO operating system image](./nao_image_and_sdk.md) and Software Development Toolkit (SDK) to cross-compile for the NAO,
- [setup the NAO](./nao_setup.md) by flashing the operating system image to the NAO,
- and [compile, upload, and run](./upload.md) the HULKs robotics software on the robot

!!! tip

If you are finished here, continue reading about our [workflow](../workflow/getting_started.md) and how to get started developing.

0 comments on commit 45bbd6c

Please sign in to comment.