From 3e8269c4fb2f93ccf2ddae7378a593f6b3c42c41 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Wed, 7 Oct 2026 23:59:17 +0800 Subject: [PATCH] Complete the README run instructions The Run section now covers all five challenges, the --gap option and how to call the functions from other code. Task: MIL-004#5 --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a8247a2..522401f 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,14 @@ python -m turtle_challenges dashed-line | 1. Draw a square | `turtle-challenges square` | `draw_square` | | 2. Draw a dashed line | `turtle-challenges dashed-line` | `draw_dashed_line` | | 3. Draw different shapes | `turtle-challenges shapes` | `draw_shape`, `draw_shapes`, `random_color` | +| 4. Generate a random walk | `turtle-challenges random-walk` | `random_walk` | +| 5. Draw a spirograph | `turtle-challenges spirograph` | `draw_spirograph` | -Challenges 4 and 5 are added by milestone 004. +The spirograph takes the number of degrees between two circles with `--gap` (default 5): + +```bash +turtle-challenges spirograph --gap 10 +``` `turtle-challenges --help` lists the challenges. If the command prints that the turtle module needs Tk, install Tk as described under Requirements. @@ -137,6 +143,8 @@ Open `build/html/index.html` in a browser. Any Doxygen warning fails the build, │ ├── square.py challenge 1: draw_square │ ├── dashed_line.py challenge 2: draw_dashed_line │ ├── shapes.py challenge 3: draw_shape, draw_shapes +│ ├── random_walk.py challenge 4: random_walk +│ ├── spirograph.py challenge 5: draw_spirograph │ └── cli.py the turtle-challenges command ├── tests/ pytest tests and the recording fake pen ├── Doxyfile Doxygen configuration