Skip to content

Commit

Permalink
Update doc for vcpkg
Browse files Browse the repository at this point in the history
  • Loading branch information
meynardc authored and Christophe Meynard committed Jul 31, 2024
1 parent af8c0fe commit 2aba15b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
21 changes: 6 additions & 15 deletions MMVII/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Under Linux (Ubuntu) distribution the installation procedure is as follows:
```bash
mkdir build && cd build
```
- Generate makefiles:
- Configure CMAKE and generate makefiles:
```bash
cmake ../
```
Expand All @@ -77,7 +77,7 @@ Before starting the installation, it is necessary to install **MicMac v1** by fo

Under Windows the installation procedure is as follows:

### Install PROJ via vcpkg
### Install vcpkg (if not done for **MicMac v1**)
- Open a **Git Bash** terminal
- In another working directory, clone the repository:
```bash
Expand All @@ -94,10 +94,6 @@ Under Windows the installation procedure is as follows:
```bash
vcpkg.exe integrate install
```
- Install PROJ:
```bash
vcpkg install proj --triplet x64-windows
```

### Install MMVII
- Open a **Git Bash** terminal
Expand All @@ -109,7 +105,7 @@ Under Windows the installation procedure is as follows:
```bash
mkdir build && cd build
```
- Specify `CMAKE_TOOLCHAIN_FILE` variable:
- Configure cmake and generate Makefiles:
```bash
"[CMAKE_DIR]/cmake.exe" .. "-DCMAKE_TOOLCHAIN_FILE=[VCPKG_DIR]/vcpkg/scripts/buildsystems/vcpkg.cmake"
```
Expand Down Expand Up @@ -181,18 +177,13 @@ After making this modification, the command completion feature will be active in
### Graphical User Interface vMMVII
The **vMMVII** tool provides a convenient graphical user interface (GUI) for writing **MMVII** commands.
To compile it, add "**-DvMMVII_BUILD=ON**" on then cmake configure command line.
If you have the Qt5 (or Qt6) development package installed, **vMMVII** will be automatically compiled with **MMVII**.
For Ubuntu 22.04, you can install the necessary package with the following command:
For Ubuntu 22.04, you can install the necessary QT5 package with the following command:
```bash
sudo apt install qtbase5-dev
```
For windows, you can download and install Qt from **[HERE](https://www.qt.io/download)** and adapt the following command:
```bash
"[CMAKE_DIR]\cmake.exe" .. "-DCMAKE_TOOLCHAIN_FILE=[VCPKG_DIR]vcpkg\scripts\buildsystems\vcpkg.cmake" “-DCMAKE_PREFIX_PATH=[QT_DIR]\msvc2019_64”
```
For windows, it will be automatically downloaded and compiled (may take a very long time the first time)
To use **vMMVII**, simply type `vMMVII` in a terminal in your working directory.
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,17 @@ Under Linux (Ubuntu) distribution the installation procedure is as follows:
Under Windows the installation procedure is as follows:
- Download and Install **[Build Tools for Visual Studio](https://visualstudio.microsoft.com/)**
- Download and Install **[Git](https://git-scm.com/)**
- Download and Install **[CMake](https://cmake.org/)**
- Download and Install **[Qt](https://www.qt.io/)** (optionnal)
- Download and Install **[CMake](https://cmake.org/)**. Make sure cmake.exe is in the %PATH%
- Open a **Git Bash** terminal
- Optionnal, QT5 tools : Download and Install **[vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started)**
in a general directory (c:\pgms, for example):
```bash
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg
bootstrap-vcpkg.bat
vcpkg.exe integrate install

```
- Clone the repository:
```sh
git clone https://github.com/micmacIGN/micmac.git
Expand All @@ -99,12 +107,18 @@ Under Windows the installation procedure is as follows:
mkdir build && cd build
```
- Generate Microsoft Visual Studio Solution File **MICMAC.sln**:

- Without Qt5 Tools:
```bash
"[CMAKE_DIR]/cmake.exe" ..
cmake.exe ..
```
- With Qt5 Tools (This will download and compile QT5, it will take a very long time):
```bash
cmake .. -DWITH_QT5=1 -DCMAKE_TOOLCHAIN_FILE=c:/pgms/vcpkg/script/buildsystem/vcpkg.cmake
```
- Compile **MicMac**:
```bash
"[CMAKE_DIR]/cmake.exe" --build . --config Release --target INSTALL
cmake.exe" --build . --config Release --target INSTALL
```
- Add binaries to Windows `PATH` environment variable via **Advanced system settings** menu. Example of path (**adapt the path**):
```bash
Expand Down Expand Up @@ -178,7 +192,7 @@ Under macOS the installation procedure is as follows:
brew doctor
```
### Qt Tools
### Qt Tools (Linux, MacOS)
To use Qt GUIs, you need to adapt the **cmake** command as follows:
```bash
cmake ../ -DWITH_QT5=1
Expand Down

0 comments on commit 2aba15b

Please sign in to comment.