Skip to content
This repository was archived by the owner on Jan 16, 2024. It is now read-only.

Commit a366c94

Browse files
authored
Update README.md
1 parent 33cbb12 commit a366c94

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
# ng-test
22
A test library for NodeGUI widgets
33

4-
### Features
4+
### Installation
5+
The recommended way of getting started with using `@ng-qt/ng-test` is by utilizing our [Qode image](https://github.com/ng-qt/qode-docker-image) for [Docker](https://docker.com), which will set up a completely development & testing ready environment for you to use.
6+
> If you'd prefer not to use Docker, you'd need to specify the associated environment variables which can be found in the [environment section](https://github.com/ng-qt/qode-docker-image#environment) and install the dependencies specified in the prerequisites as well.
7+
8+
```sh
9+
$ yarn add -D @ng-qt/ng-test
10+
```
11+
12+
#### Prerequisites
13+
* [Qt5](https://doc.qt.io/qt-5/qt5-intro.html)
14+
* [Node.js](https://nodejs.org)
15+
* [CMake](https://cmake.org)
16+
17+
### Usage
18+
[API documentation](https://github.com/ng-qt/ng-test/docs/classes/ngtest.md)
19+
20+
#### Features
521
* [x] [keyClick](https://doc.qt.io/qt-5/qtest.html#keyClick)
622
* [x] [keyPress](https://doc.qt.io/qt-5/qtest.html#keyPress)
723
* [x] [keyClicks](https://doc.qt.io/qt-5/qtest.html#keyClicks)
@@ -16,11 +32,6 @@ A test library for NodeGUI widgets
1632
* [ ] [mouseRelease](https://doc.qt.io/qt-5/qtest.html#mouseRelease)
1733
* [ ] [touchEvent](https://doc.qt.io/qt-5/qtest.html#touchEvent)
1834

19-
### Installation
20-
21-
### Usage
22-
[API documentation](docs/classes/ngtest.md)
23-
2435
### Development
2536
The recommended way of getting started with contributing is using [Docker](https://docker.com)
2637

@@ -31,8 +42,3 @@ Run the following command to start the **ng-test** development environment for [
3142
```
3243
$ ./docker-dev.sh
3344
```
34-
35-
#### Requirements
36-
* [Docker](https://docker.com)
37-
* [Qt5](https://doc.qt.io/qt-5/qt5-intro.html)
38-
* [Node.js](https://nodejs.org)

0 commit comments

Comments
 (0)