From 99c75ff24ba45e8d6f2861bd3dd4d35cd4c7a9d4 Mon Sep 17 00:00:00 2001
From: Blake-Madden <66873089+Blake-Madden@users.noreply.github.com>
Date: Mon, 2 Sep 2024 09:31:57 -0400
Subject: [PATCH] Document building GUI

---
 README.md | 34 ++++++++++++++++++++++++++++++----
 1 file changed, 30 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 60c5bd9..694840a 100644
--- a/README.md
+++ b/README.md
@@ -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.