moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Missing packages in vcpkg prerequisites page #54

Closed sarahhaggarty closed 3 years ago

sarahhaggarty commented 3 years ago

What does the current documentation state? In "vcpkg.rst" it lists the following command for installing packages for vcpkg:

vcpkg.exe install boost-test:x64-windows boost-program-options:x64-windows boost-log:x64-windows turtle:x64-windows zipper:x64-windows poco:x64-windows libpq:x64-windows gdal:x64-windows sqlite3:x64-windows boost-ublas:x64-windows

Where is this stated? In "vcpkg.rst"

Why do you want to improve the statement? The current command is missing two packages: fmt:x64-windows and libpqxx:x64-windows. So if readers complete the prerequisite instructions to install vcpkg when they try to compile with CMake they will receive the following error:

CMake Error at C:/Development/moja-global/vcpkg/scripts/buildsystems/vcpkg.cmake:288 (_find_package):
  Could not find a package configuration file provided by "fmt" with any of
  the following names:

    fmtConfig.cmake
    fmt-config.cmake

Proposed statement The command should be corrected to the following:

vcpkg.exe install boost-test:x64-windows boost-program-options:x64-windows boost-log:x64-windows turtle:x64-windows zipper:x64-windows poco:x64-windows libpq:x64-windows gdal:x64-windows sqlite3:x64-windows boost-ublas:x64-windows fmt:x64-windows libpqxx:x64-windows

Additional info Installing vcpkg is also mentioned in "windows_installation.rst" and "visual_studio_win_example.rst" but those commands are both the same and contain fmt:x64-windows. Making this correction to "vcpkg.rst" will mean all pages have the same vcpkg command.

sarahhaggarty commented 3 years ago

Hi @HarshCasper, I think this would be good to label as a good first issue. What do you think?

HarshCasper commented 3 years ago

Hi @HarshCasper, I think this would be good to label as a good first issue. What do you think?

Definitely. I have labelled them here. Thanks for suggesting :)

Sukriti-sood commented 3 years ago

@sarahhaggarty @HarshCasper Can I work on this issue?

HarshCasper commented 3 years ago

@sarahhaggarty @HarshCasper Can I work on this issue?

Please go ahead!