Skip to content

Commit 4d74169

Browse files
committed
escape refs
1 parent 618816e commit 4d74169

File tree

7 files changed

+61
-45
lines changed

7 files changed

+61
-45
lines changed

RIOT/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# RIOT - README
22

33
This folder contains several exercises and tasks to get familiar with RIOT, the
4-
friendly operating system for the Internet of Things (IoT) [1], [2]. RIOT is an
4+
friendly operating system for the Internet of Things (IoT) \[1\], \[2\]. RIOT is an
55
open source project and aims to foster usage of open standards, technologies
66
and protocols in the IoT.
77

88
The exercises are grouped into folders each covering a certain topic. Not all
99
tasks start from scratch, thus they may rely on or reference other tasks.
1010

11-
[1]: http://www.riot-os.org/
12-
[2]: https://github.com/RIOT-OS/RIOT
11+
\[1\] [http://www.riot-os.org/](http://www.riot-os.org/)
12+
13+
\[2\] [https://github.com/RIOT-OS/RIOT](https://github.com/RIOT-OS/RIOT)

RIOT/coap/01_coap_server.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
## Description
77

88
The objective of this exercise is to implement a simple CoAP server in RIOT.
9-
CoAP [1] is a HTTP like protocol for constraint network and nodes that allows
10-
to implement RESTful services [2].
9+
CoAP \[1\] is a HTTP like protocol for constraint network and nodes that allows
10+
to implement RESTful services \[2\].
1111

1212
## Instructions
1313

@@ -17,13 +17,15 @@ to implement RESTful services [2].
1717
- `info/mcu` returns the RIOT MCU name
1818
3. The tool should print all unicast IPv6 addresses during start.
1919
4. Compile and start the tool using RIOT native and a tap interface
20-
5. Use the libcoap client [3] to discover the resources via `.well-known/core`
20+
5. Use the libcoap client \[3\] to discover the resources via `.well-known/core`
2121
and retrieve available resources; use one of the IPs output, see above.
2222

2323
Document _all_ your actions and findings. Create an archive with your solution.
2424

2525
## References
2626

27-
[1]: http://coap.technology/
28-
[2]: https://en.wikipedia.org/wiki/Representational_state_transfer
29-
[3]: https://libcoap.net/
27+
\[1\] [http://coap.technology/](http://coap.technology/)
28+
29+
\[2\] [https://en.wikipedia.org/wiki/Representational_state_transfer](https://en.wikipedia.org/wiki/Representational_state_transfer)
30+
31+
\[3\] [https://libcoap.net/](https://libcoap.net/)

RIOT/coap/02_coap_json_server.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ JSON as content formats. It extends on the previous task.
1010

1111
## Instructions
1212

13-
1. Extend the simple CoAP server, implemented as described in [1].
14-
2. Change the content format of all resources to JSON, use the jsmn package [2].
13+
1. Extend the simple CoAP server, implemented as described in \[1\].
14+
2. Change the content format of all resources to JSON, use the jsmn package \[2\].
1515
3. Create a 3rd resource `print/` that handles CoAP PUT messages and outputs the
1616
packet content. Packet content format should be JSON: `{ 'msg': '<text>'}`,
1717
`<text>` should be printed.
@@ -21,5 +21,6 @@ Document _all_ your actions and findings. Create an archive with your solution.
2121

2222
## References
2323

24-
[1]: https://github.com/smartuni/exercises/RIOT/coap/01_coap_server.md
25-
[2]: https://github.com/zserge/jsmn
24+
\[1\]: [https://github.com/RIOT-OS/Exercises/blob/master/RIOT/coap/01_coap_server.md](https://github.com/RIOT-OS/Exercises/blob/master/RIOT/coap/01_coap_server.md)
25+
26+
\[2\]: [https://github.com/zserge/jsmn](https://github.com/zserge/jsmn)

RIOT/documentation/01_tests.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
## Description
77

88
The objective of this exercise is to extend existing documentation or add new
9-
documentation to the tests in
10-
[RIOT/tests/](https://github.com/RIOT-OS/RIOT/tree/master/tests) in form of
11-
`README.md` files.
9+
documentation to the tests in RIOT/tests/ \[1\] in form of `README.md` files.
1210

1311
## Instructions
1412

1513
1. Inspect current `README.md` files in `RIOT/tests`
1614
2. If a test does not contain a `README.md`, then this could be a good candidate
1715
3. Pick a `README.md` that contains vague descriptions and enhance it
18-
4. Provide a Pull Request to the official
19-
[RIOT](https://github.com/RIOT-OS/RIOT) repository.
16+
4. Provide a Pull Request to the official RIOT \[2\] repository.
2017

2118
## References
19+
\[1\] [https://github.com/RIOT-OS/RIOT/tree/master/tests](https://github.com/RIOT-OS/RIOT/tree/master/tests)
20+
21+
\[2\] [https://github.com/RIOT-OS/RIOT](https://github.com/RIOT-OS/RIOT)

RIOT/documentation/02_doxygen.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
## Description
77

88
The objective of this exercise is to enhance existing documentation or add new
9-
documentation to the automatically generated doxygen
10-
[documentation](http://doc.riot-os.org/)
11-
9+
documentation to the automatically generated doxygen documentation.
1210
## Instructions
1311

14-
1. Inspect the doxygen [documentation](http://doc.riot-os.org/)
12+
1. Inspect the doxygen documentation \[1\]
1513
2. Search for text blocks that are vague or contain spelling errors
16-
3. Provide a Pull Request to the official
17-
[RIOT](https://github.com/RIOT-OS/RIOT) repository.
14+
3. Provide a Pull Request to the official RIOT \[2\] repository.
1815

1916
## References
17+
\[1\] [http://doc.riot-os.org/](http://doc.riot-os.org/)
18+
19+
\[2\] [https://github.com/RIOT-OS/RIOT](https://github.com/RIOT-OS/RIOT)

RIOT/system/01_shell_command_morse.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,21 @@ which parses input strings to Morse signals expressed via LED.
1010

1111
## Instructions
1212

13-
1. Get familiar with the shell using [1] and the timer module xtimer [2].
14-
2. Program a shell command handler that parses strings to Morse code [3]. Note
13+
1. Get familiar with the shell using \[1\] and the timer module xtimer \[2\].
14+
2. Program a shell command handler that parses strings to Morse code \[3\]. Note
1515
that you don't necessarily need a board for development. You can also
16-
develop under native [4] as there is an LED abstraction.
16+
develop under native \[4\] as there is an LED abstraction.
1717
3. Generate a new module with your code under *RIOT/drivers* which can be included
1818
via Makefile.
1919

2020
Document _all_ your actions and findings. Create an archive with your solution.
2121

2222
## References
2323

24-
[1]: https://github.com/RIOT-OS/RIOT/tree/master/tests/shell
25-
[2]: https://riot-os.org/api/group__sys__xtimer.html
26-
[3]: https://en.wikipedia.org/wiki/Morse_code
27-
[4]: https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native
24+
\[1\] [https://github.com/RIOT-OS/RIOT/tree/master/tests/shell](https://github.com/RIOT-OS/RIOT/tree/master/tests/shell)
25+
26+
\[2\] [https://riot-os.org/api/group__sys__xtimer.html](https://riot-os.org/api/group__sys__xtimer.html)
27+
28+
\[3\] [https://en.wikipedia.org/wiki/Morse_code](https://en.wikipedia.org/wiki/Morse_code)
29+
30+
\[4\] [https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native](https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native)

RIOT/system/02_network_udp_stats.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,43 @@ to write a module that collects minimal statistics on the transport layer.
1111
## Instructions
1212

1313
1. Get familiar with networking by using RIOTs default networking
14-
example `gnrc_networking` [1] and exchange UDP packets between two instances
15-
(either boards or RIOT native [2]) following these steps:
16-
* Go to the [`gnrc_networking` application](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking)
17-
and have a look in `udp.c` how packets are constructed, send and received
14+
example `gnrc_networking` \[1\] and exchange UDP packets between two instances
15+
(either boards or RIOT native \[2\]) following these steps:
16+
* Go to the `gnrc_networking` application \[3\] and have a look in `udp.c` how
17+
packets are constructed, send and received
1818
* Compile, flash, and run on your board `BOARD=samr21-xpro make all flash term`
1919
or native `make clean all term PORT=tap0` resp. `tap1`
2020
* Type `help`
2121
* Start UDP server on port 8888 using `udp server 8888`
2222
* Get your IPv6 address using `ifconfig`
2323
* Send your neighbor some messages using `udp send`
24-
* [Read the Doc](http://doc.riot-os.org/group__net__gnrc.html)
24+
* Read the Doc \[4\]
2525

2626
2. Now that you've used the whole UDP/IPv6 network stack, have a look inside the
27-
implementation of UDP [3]. The goal is to write a software component which collects and prints
27+
implementation of UDP \[5\]. The goal is to write a software component which collects and prints
2828
simple statistics about the amount of UDP packets and data that has been sent and received.
2929

3030
3. There is an existing `netstats` module in RIOT which is used in `gnrc_networking` by default
31-
and should be extended. Have a look the the header [4] and implementation for e.g. IPv6 [5]
32-
and see how statistics are collected and when they are printed to the console [6]. Note that
31+
and should be extended. Have a look the the header \[6\] and implementation for e.g. IPv6 \[7\]
32+
and see how statistics are collected and when they are printed to the console \[8\]. Note that
3333
this tasks requires a certain amount of personal contribution.
3434

3535
Document _all_ your actions and findings. Create an archive with your solution.
3636

3737
## References
3838

39-
[1]: https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking
40-
[2]: https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native
41-
[3]: https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/transport_layer/udp/gnrc_udp.c
42-
[4]: https://github.com/RIOT-OS/RIOT/blob/master/sys/include/net/netstats.h
43-
[5]: https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/network_layer/ipv6/gnrc_ipv6.c
44-
[6]: https://github.com/RIOT-OS/RIOT/blob/master/sys/shell/commands/sc_netif.c
39+
\[1\] [https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking)
40+
41+
\[2\] [https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native](https://github.com/RIOT-OS/RIOT/wiki/Family%3A-native)
42+
43+
\[3\] [https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking](https://github.com/RIOT-OS/RIOT/tree/master/examples/gnrc_networking)
44+
45+
\[4\] [http://doc.riot-os.org/group__net__gnrc.html](http://doc.riot-os.org/group__net__gnrc.html)
46+
47+
\[5\] [https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/transport_layer/udp/gnrc_udp.c](https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/transport_layer/udp/gnrc_udp.c)
48+
49+
\[6\] [https://github.com/RIOT-OS/RIOT/blob/master/sys/include/net/netstats.h](https://github.com/RIOT-OS/RIOT/blob/master/sys/include/net/netstats.h)
50+
51+
\[7\] [https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/network_layer/ipv6/gnrc_ipv6.c](https://github.com/RIOT-OS/RIOT/blob/master/sys/net/gnrc/network_layer/ipv6/gnrc_ipv6.c)
52+
53+
\[8\] [https://github.com/RIOT-OS/RIOT/blob/master/sys/shell/commands/sc_netif.c](https://github.com/RIOT-OS/RIOT/blob/master/sys/shell/commands/sc_netif.c)

0 commit comments

Comments
 (0)