Skip to content

Commit

Permalink
Document building GUI
Browse files Browse the repository at this point in the history
  • Loading branch information
Blake-Madden committed Sep 2, 2024
1 parent 086d154 commit 99c75ff
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,21 +191,47 @@ i18n-check C:\src\Wisteria-dataviz\src --ignore=import,i18n-check,wxsimplejson,w

Refer [here](Example.md) for more examples.

# Building
# Building (command line tool)

`i18n-check` can be configured with Cmake and then built with your compiler of choice.
`i18n-check` can be configured and built with *Cmake*.

On Unix:

```shellscript
cmake ./
make -j4
cmake .
cmake --build . --target all -j $(nproc)
```

On Windows, "CMakeLists.txt" can be opened and built directly in Visual Studio.

After building, "i18n-check" will then be available in the "bin" folder.

# Building (GUI)

[wxWidgets](https://github.com/wxWidgets/wxWidgets) 3.3 or higher is required for building the graphical user interface version for `i18n-check`.

Download [wxWidgets](https://github.com/wxWidgets/wxWidgets), placing it at the same folder level as `i18n-check`:

```
git clone https://github.com/wxWidgets/wxWidgets.git --recurse-submodules
```

Refer [here](https://github.com/wxWidgets/wxWidgets/blob/master/README-GIT.md) for how to build wxWidgets.

After building wxWidgets, `ii18n-gui` can be configured and built with *Cmake*.

On Unix:

```shellscript
cd gui
cmake .
cmake --build . --target all -j $(nproc)
```

On Windows, "gui/CMakeLists.txt" can be opened and built directly in Visual Studio.

After building, "ii18n-gui" will then be available in the "bin" folder.

# GitHub Action

You can also create an `i18n-check` GitHub action to make it part of your CI.
Expand Down

0 comments on commit 99c75ff

Please sign in to comment.