Skip to content

Commit

Permalink
Add Windows build to doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
suikan4github committed Nov 2, 2024
1 parent e163161 commit edeba01
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ apt-get -y install doxygen graphviz

- Refer [BAREMETAL.md](docs/BAREMETAL.md) for the Raspberry Pi Pico target.
- Refer [LINUX.md](docs/LINUX.md) for the Linux target.
- Refer [WINDOWS.md](docs/WINDOWS.md) for the Windows target.

As of 2024/Nov, Windows target is unable to configure from VS Code. Our recommendation is WSL, instead of Windows native as a development environment.

## License
This project is shared with the [MIT License](LICENSE).
This project is shared under the [MIT License](LICENSE).
46 changes: 46 additions & 0 deletions docs/WINDOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Building for the Windows target

In this file, we explain how to build your code for the Linux target.

We see one way to build
- CLI ( Command Line Interface )


## Configuration and building on CLI

```sh
cmake -B build -S . -DCMAKE_C_COMPILER=cl -DCMAKE_CXX_COMPILER=cl -A x64
cmake --build build --target all
```

## Configuration and building on VS Code

As of 2024/Nov, we cannot configure this project on the VS Code.

Once configuration is done from CLI, we can build the project from GUI.
Click the "Build" button in the status bar.

![](../image/statusbar.png)


## How to run the application from CLI
From the command line, run the following command :
```sh
build\src\Debug\app.exe
```

## How to run the application from VS Code
From the VS Code, click the run (▷) button to run the program.

![](../image/statusbar.png)


## How to run the test from CLI
From the command line, run the following command :
```sh
ctest --test-dir build
```
## How to run the test from VS Code
From the VS Code, click the Test extension, and then run.

![](../image/test.png)

0 comments on commit edeba01

Please sign in to comment.