Skip to content

Commit 6a292f2

Browse files
docs: add documentation for the examples (#288)
Co-authored-by: Manuel Pol <[email protected]>
1 parent d20691b commit 6a292f2

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ You can access it [here](https://megaredhand.github.io/network-simulator/).
1313
- [GEduNet 🌐](#gedunet-)
1414
- [**GEduNet - User Manual** 📘](#gedunet---user-manual-)
1515
- [Getting Started](#getting-started)
16+
- [User Interface](#user-interface)
1617
- [Left Bar](#left-bar)
1718
- [Right Bar](#right-bar)
1819
- [Top Bar](#top-bar)
@@ -62,6 +63,11 @@ You can access it [here](https://megaredhand.github.io/network-simulator/).
6263

6364
Welcome to the GEduNet simulator! This application is designed to help you visualize and understand computer networks.
6465

66+
This repository includes some examples under `examples/`.
67+
You can download and load them into the simulator like any other network.
68+
69+
## User Interface
70+
6571
GEduNet consists of 4 main components on screen:
6672

6773
1. Right bar: Shows information about the selected device.

examples/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Examples
2+
3+
This directory has some example networks ready to be loaded into the simulator.
4+
We also include some information on each example here.
5+
6+
## [HTTP Client-Server](./httpClientServer.json)
7+
8+
This example includes three hosts and two routers, simulating a server and multiple clients that communicate through the internet.
9+
To see it in action, run the HTTP request program in one of the clients, selecting the HTTP server as the destination.
10+
11+
## [Local network](./localNetwork.json)
12+
13+
This example includes three hosts connected by a single switch, simulating a local area network.
14+
A good place to check how ARP requests work!
15+
16+
## [Misconfigured router](./misconfiguredRouter.json)
17+
18+
This example includes two hosts connected through a loop of three routers.
19+
One of the hosts is running the "Echo server" program, which regularly sends ICMP echo packets.
20+
However, the packets don't ever reach the other host, since one of the router's routing tables is misconfigured.
21+
The routing table entry for the receiving host instead points to the next router on the loop, causing the packet to be forever lost in the network.
22+
After a while, the packets are dropped due to their TTL decreasing to zero.
23+
24+
## [Subnetting](./subnetting.json)
25+
26+
This example includes multiple hosts, routers, and switches.
27+
Each host represents a group of hosts, shown in their tags.
28+
It was inspired by an exercise on subnet partitioning and routing table configuration.

0 commit comments

Comments
 (0)