Skip to content

Commit 3007be5

Browse files
authored
[BugFix] Correct tutorial (#71)
Signed-off-by: Douglas Chiang <[email protected]>
1 parent 1a38d0d commit 3007be5

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

docs/tutorial/getting_started.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**YARF** is a tool built upon [Robot Framework][robot-framework] that allows developers to build complex visual test scenarios and bootstrap them locally, and then work towards automated runs in continuous integration (CI) and use of platforms/fixtures with minimal effort. In YARF, we support the Mir as one of our default platform.
44

5-
**Mir** is a display server that is suitable for local development and continuous integration. In this tutorial, we will use Mir to display an application called `simple-counter` and then use YARF to perform actions and run tests on it. For details please visit [here][mir-docs].
5+
**Mir** is a display server that is suitable for local development and continuous integration. In this tutorial, we will use Mir to display the calcualtor and then use YARF to perform actions and run tests on it. For details please visit [here][mir-docs].
66

77
In this tutorial, we will go through the process of setting up YARF and a Mir server, then we will start a calculator app inside the Mir server and use YARF to do some simple calculations.
88

@@ -46,20 +46,6 @@ caption: The command to install mir-test-tools
4646
sudo snap install mir-test-tools
4747
```
4848

49-
After that, we will install some dependencies that the `simple-counter` required:
50-
51-
```{code-block} bash
52-
---
53-
caption: Command for installing simple-counter dependencies.
54-
---
55-
sudo apt update
56-
sudo apt install \
57-
python3-gi \
58-
gir1.2-gtk-4.0 \
59-
libadwaita-1-dev \
60-
gir1.2-adw-1
61-
```
62-
6349
### Starting the Mir server
6450

6551
Now, let's start the Mir server:
@@ -115,7 +101,7 @@ The mir test tools window
115101

116102
### Starting the calculator app
117103

118-
Now, we can start our `simple-counter` by running under the same terminal:
104+
Now, we can start our calculator by running under the same terminal:
119105

120106
```{code-block} bash
121107
---

docs/tutorial/writting-a-test-suite.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,29 @@ To do this, we will go through the following steps:
3434

3535
## Setup
3636

37-
First, we start the Mir server up as described in the [getting started tutorial][getting-started]. Then we install `uv` following the [official installation guide][uv-installation-guide].
38-
After that we run the `simple-counter`:
37+
First, we start the Mir server up as described in the [getting started tutorial][getting-started].
38+
Then, we install some dependencies that the `simple-counter` required:
39+
40+
```{code-block} bash
41+
---
42+
caption: Command for installing simple-counter dependencies.
43+
---
44+
sudo apt update
45+
sudo apt install \
46+
python3-gi \
47+
gir1.2-gtk-4.0 \
48+
libadwaita-1-dev \
49+
gir1.2-adw-1
50+
```
51+
52+
After that, we install `uv` following the [official installation guide][uv-installation-guide] and run the `simple-counter`:
3953

4054
```{code-block} bash
4155
---
4256
caption: The commands that starts a virtual environment and running the
4357
simple-counter app inside it.
4458
---
45-
uv venv --python=/usr/bin/python3 --system-site-packages --project=$(pwd)/examples/yarf-example-simple-counter
59+
uv --no-managed-python venv --system-site-packages --project=$(pwd)/examples/yarf-example-simple-counter
4660
uv --project=$(pwd)/examples/yarf-example-simple-counter run simple-counter &
4761
```
4862

0 commit comments

Comments
 (0)