Skip to content

Commit 1c889b1

Browse files
authored
Merge pull request #93 from AnnsAnns/guide_link
README: Switch to Guide Link
2 parents 44c8dff + 36880e4 commit 1c889b1

1 file changed

Lines changed: 8 additions & 60 deletions

File tree

README.md

Lines changed: 8 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,15 @@
22

33
## Preparations
44

5-
For links go to [https://github.com/RIOT-OS/Tutorials](https://github.com/RIOT-OS/Tutorials)
5+
> [!IMPORTANT]
6+
> It is strongly recommended to first read through
7+
> [RIOT's Getting Started Guide](https://guide.riot-os.org/getting-started/installing/)
8+
> before continuing with the exercises!
9+
>
10+
> It teaches some of the fundamentals of RIOT and helps you get a working
11+
> development environment up and running.
612
7-
**Quick Setup using a Virtual Machine (recommended for this Tutorial)**
8-
9-
* Install and set up [git](https://help.github.com/articles/set-up-git/)
10-
* Install latest [VirtualBox](https://www.virtualbox.org/wiki/Downloads) & [VirtualBox Extension Pack](https://www.virtualbox.org/wiki/Downloads) for **your system**
11-
* Install [Vagrant](https://www.vagrantup.com/downloads.html)
12-
* Linux, OSX:
13-
```Shell
14-
git clone --recursive https://github.com/RIOT-OS/Tutorials
15-
cd Tutorials
16-
```
17-
* Windows:
18-
* set
19-
```Shell
20-
git config --global core.autocrlf input
21-
```
22-
before cloning
23-
* clone the `Tutorials` and the `RIOT` submodule as follows:
24-
```Shell
25-
git clone https://github.com/RIOT-OS/Tutorials
26-
cd Tutorials
27-
git submodule update --init --recursive
28-
```
29-
* In case a virtual machine is disseminated locally, adapt the path for the vagrant box `vagrant box add RIOT/ubuntu1804 <path to box>`
30-
* Run `vagrant up` and `vagrant ssh` afterwards. See the [Vagrant RIOT Setup](https://github.com/RIOT-OS/RIOT/blob/master/dist/tools/vagrant/README.md) for a more general explanation.
31-
32-
**Regular Setup without using a VM (recommended for RIOT developement)**
33-
34-
* Install and set up [git](https://help.github.com/articles/set-up-git/)
35-
* Install the build-essential packet (make, gcc etc.). This varies based on the operating system in use.
36-
* Install [Native dependencies](https://github.com/RIOT-OS/RIOT/wiki/Family:-native#dependencies)
37-
* Install [OpenOCD](https://github.com/RIOT-OS/RIOT/wiki/OpenOCD)
38-
* Install [GCC Arm Embedded Toolchain](https://launchpad.net/gcc-arm-embedded)
39-
* On OS X: install [Tuntap for OS X](http://tuntaposx.sourceforge.net/)
40-
* [additional tweaks](https://github.com/RIOT-OS/RIOT/wiki/Board:-Samr21-xpro) necessary to work with the targeted hardware (ATSAMR21)
41-
* Install `netcat` with IPv6 support (if necessary)
42-
43-
```bash
44-
sudo apt-get install netcat-openbsd
45-
```
13+
## Usage
4614

4715
* `git clone --recursive https://github.com/RIOT-OS/Tutorials`
4816
* Go to the Tutorials directory: `cd Tutorials`
@@ -58,26 +26,6 @@ For links go to [https://github.com/RIOT-OS/Tutorials](https://github.com/RIOT-O
5826
* [Task 8: CCN-Lite on RIOT](task-08/)
5927
* [Task 9: RIOT and RPL](task-09/)
6028

61-
## Troubleshooting
62-
63-
### If you get the following error after running `vagrant up`
64-
65-
> The guest machine entered an invalid state while waiting for it to boot. Valid states are 'starting, running'. The machine is in the 'poweroff' state.
66-
67-
Make sure you have the [Extension Pack](https://www.virtualbox.org/wiki/Downloads) installed.
68-
69-
### If you cannot flash a connected board (`/dev/ttyXXXX` does not exist)
70-
71-
Make sure your user is a member of the usergroup `vboxusers`. On Linux you can add the current user with
72-
73-
`usermod -a -G vboxusers $USER`.
74-
75-
You can check the groups of your user with
76-
77-
`groups`.
78-
79-
Note that you need to log out once to reload a Linux user's group assignments
80-
8129
## License
8230
This work and all its related code and documents are licensed under a
8331
[Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)

0 commit comments

Comments
 (0)