Skip to content

Commit 179297a

Browse files
author
Felipe Torrezan
authored
Update README.md
- Fix mispellings
1 parent 2edb21f commit 179297a

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

tests/README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,23 @@ The tests in this directory are for the CMake Modules for the IAR Toolchains (e.
33

44
The `run-tests.sh` script will...
55
- build one executable for each supported language (`C`, `CXX` and `ASM`) using...
6-
- the the default CMake build configurations (`Debug`, `Release`, `DebWithRelInfo` and `MinSizeRel`).
6+
- the default CMake build configurations (`Debug`, `Release`, `DebWithRelInfo` and `MinSizeRel`).
77

88
## Environment
9-
The following GNU Bash environments were used:
9+
The script was used with the following environments providing GNU Bash:
10+
11+
- Cygwin (https://cygwin.com)
12+
- IAR Embedded Workbench
13+
- CMake for Windows
14+
- Ninja for Windows
1015
- MINGW64 (https://msys2.org)
11-
- WSL2/Ubuntu 20.04 (IAR Build Tools for Linux)
12-
- CYGWIN64 (https://cygwin.com)
16+
- IAR Embedded Workbench
17+
- CMake for Windows
18+
- Ninja for Windows
19+
- Ubuntu 20.04 (/WSL2)
20+
- IAR Build Tools for Linux
21+
- Cmake for Linux
22+
- Ninja for Linux
1323

1424
## Environment variables
1525
### IAR_TOOL_ROOT
@@ -23,17 +33,19 @@ Export the `$IAR_TOOL_ROOT` environment variable, pointing to the top-level loca
2333
| `/c/IAR_Systems/EW/ARM/9.30.1` | Perform tests only using "Embedded Workbench 9.30.1". |
2434

2535
### IAR_LMS2_SERVER_IP (optional)
26-
Export the `IAR_LMS2_SERVER_IP` environment pointing to the license server, if the client's 1st-time license setup is required. Applies to the `-GL` and `-NW` products. (Default: not set)
36+
Export the `IAR_LMS2_SERVER_IP` environment variable pointing to the license server, if the client's 1st-time license setup is required. Applies to the `-GL` and `-NW` products. (Default: not set)
2737

2838
### CMAKE_MAKE_PROGRAM (optional)
29-
Export the `CMAKE_MAKE_PROGRAM` to specify which generator to use. (Default: `Ninja`)
39+
Export the `CMAKE_MAKE_PROGRAM` environment variable to specify which generator to use. (Default: `Ninja`)
3040

3141
### MSYSTEM
32-
This variable is automatically set by MSYS2, MINGW64 and MINGW32. CygWin users must set this environment variable manually.
42+
This environment variable is automatically set by MSYS2, MINGW64 and MINGW32. Cygwin users must set it manually.
3343

3444
Example: `export MSYSTEM=CYGWIN`
3545

36-
## Procedure example using __MINGW64__
46+
## Examples
47+
48+
### Using __MINGW64__
3749
The example below will test every tool found in `C:\IAR_Systems\EW` using MINGW64:
3850
```bash
3951
export IAR_TOOL_ROOT=/c/IAR_Systems/EW
@@ -44,15 +56,15 @@ cd ~/cmake-tutorial/tests
4456
./run-tests.sh
4557
```
4658

47-
## Procedure example using __Ubuntu on WSL2__
59+
### Using __Ubuntu (/WSL2)__
4860
The example below will test every tool found in `/opt/iarsystems` using Ubuntu (WSL2):
4961
```bash
5062
git clone https://github.com/iarsystems/cmake-tutorial ~
5163
cd ~/cmake-tutorial/tests
5264
./run-tests.sh
5365
```
5466

55-
## Procedure example using __CygWin64__
67+
### Using __Cygwin__
5668
The example below will test every tool found in `C:\IAR_Systems\EW` using Cygwin:
5769
```bash
5870
export IAR_TOOL_ROOT=/cygdrive/c/IAR_Systems/EW

0 commit comments

Comments
 (0)