Skip to content

Commit c1469b9

Browse files
committed
Further enhancements to build instructions
1 parent 51fc480 commit c1469b9

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

resources/BUILDING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ cmake -S dynadjust -B build
151151
cmake --build build --parallel
152152
```
153153

154-
## Windows using Visual Studo and CMake
154+
## Windows using Visual Studo, CMake, and vcpkg
155155

156156
### Prerequisites
157157

@@ -160,11 +160,9 @@ cmake --build build --parallel
160160
Microsoft's Visual Studio 2022 Community Edition is available from
161161
https://visualstudio.microsoft.com/vs/community/
162162

163-
C++ is required for compiling all DynAdjust binaries. MFC is only required
164-
for building `GeoidInt.exe` - Geoid Interpolation software with a
165-
(dialog-based) graphical user interface.
163+
C++ is required for compiling all DynAdjust binaries. During installation of Visual Studio, ensure C++ Desktop development and [CMake tools for Windows](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#installation) components are installed. Dot NET is not used for any DynAdjust projects, however MFC is required for building `GeoidInt.exe` (Geoid Interpolation software), which has a (dialog-based) graphical user interface.
166164

167-
During installation, ensure C++ Desktop development and [CMake tools for Windows](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#installation) components are installed. Full instructions for installing and using packages with CMake in Visual studio can be found [here](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started-vs?pivots=shell-cmd). Below is a brief summary of the steps.
165+
Full instructions for installing and using packages with CMake in Visual studio can be found [here](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started-vs?pivots=shell-cmd). Below is a brief summary of the steps.
168166

169167
#### Install git
170168

@@ -180,6 +178,8 @@ git clone https://github.com/microsoft/vcpkg C:\vcpkg
180178
C:\vcpkg\bootstrap-vcpkg.bat
181179
```
182180

181+
As per [Microsoft's guidelines](https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/cmake-integration) for setting up CMake projects to use vcpkg, DynAdjust has been configured to use the vcpkg toolchain file via the `CMakePresets.json` file. There is no need to manually change or configure the use of vcpkg.
182+
183183
#### Install dependency packages using vcpkg
184184

185185
Now we can install the dependencies.
@@ -190,23 +190,23 @@ vcpkg install boost-geometry boost-process boost-iostreams boost-spirit boost-sy
190190

191191
#### Install Code Synthesis XSD library
192192

193-
DynAdjust requires [Code Synthesis XSD](https://www.codesynthesis.com/products/xsd/) to parse XML files. Since version 1.2.9, the CMake project file will automatically download XSD. hence, there is no need to manually download and install it.
193+
DynAdjust requires [Code Synthesis XSD](https://www.codesynthesis.com/products/xsd/) to parse XML files. Since version 1.2.9, the CMake project file will automatically download XSD. Hence, there is no need to manually download and install it.
194194

195195
#### Install Intel oneAPI MKL library
196196

197-
If you do not have it, install the [Intel oneAPI Math Kernel Library {oneMKL)](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html). No extra configuration required because the installer registers MKL on the system PATH. With Visual Studio 2022 already installed, the Intel oneMKL installer
197+
If you do not have it, download and install the [Intel oneAPI Math Kernel Library {oneMKL)](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html). No extra configuration required because the installer registers MKL on the system PATH. Also, if Visual Studio 2022 is already installed, the Intel oneMKL installer
198198
will automatically enable integration into the Visual Studio 2022 IDE.
199-
This means that the oneAPI MKL and TBB libraries and headers will be
199+
This means that the oneAPI MKL libraries and headers will be
200200
automatically referenced upon compiling DynAdjust without modification.
201201

202202
### Download the DynAdjust source code
203203

204-
Download and unzip an official release (e.g. 1.2.8) to `C:\Data\Dev\` via the following command:
204+
Download and unzip an official release (e.g. 1.2.9) to `C:\Data\Dev\` via the following command:
205205

206206
```cmd
207207
cd C:\Data\Dev
208-
curl https://github.com/GeoscienceAustralia/DynAdjust/archive/refs/tags/v1.2.8.zip -o DynaDjust-1.2.8.zip
209-
tar -xf DynAdjust-1.2.8.zip
208+
curl https://github.com/GeoscienceAustralia/DynAdjust/archive/refs/tags/v1.2.9.zip -o DynaDjust-1.2.9.zip
209+
tar -xf DynAdjust-1.2.9.zip
210210
````
211211
212212
Alternativey, you can use git to get the latest version:

resources/INSTALLING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ If you see an error like **"cannot open shared object file"** revisit the prereq
129129

130130
## Docker Image
131131

132-
[![docker build](https://img.shields.io/github/workflow/status/icsm-au/dynadjust/Build%20docker%20image?label=docker%20build)](https://hub.docker.com/repository/docker/icsm/dynadjust)
132+
[![docker build](https://github.com/icsm-au/DynAdjust/actions/workflows/docker.yml/badge.svg)](https://github.com/icsm-au/DynAdjust/actions/workflows/docker.yml)
133133
[![Docker Pulls](https://img.shields.io/docker/pulls/icsm/dynadjust)](https://hub.docker.com/repository/docker/icsm/dynadjust)
134134

135135
The DynAdjust repository comes with a [Dockerfile](https://github.com/icsm-au/DynAdjust/blob/master/Dockerfile) which builds a DynAdjust docker image for the Linux environment each time changes are pushed to the main repository. This means if you have docker installed on your system, a DynAdjust image can be run on your system (whether Linux, Mac or Windows) within a virtual environment managed by docker.

0 commit comments

Comments
 (0)