moja-global / moja-global/FLINT

Updation of commands to install vcpkg packages in README.md

Open
#80 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
56
Forks
81
PR merge metrics
No merged PRs in 30d

Description

What does the current documentation state?
The current documentation under README.md has a list of commands to install vcpkg packages to run FLINT.Example and GCBM builds which result in an error due to lack of 2 more commands which have been recently updated in the official moja global developer documentation.

Why do you want to improve the statement?
Anyone who is trying to install packages directly following the instructions from README.md will face an error.

Proposed statement
The README.md file should be updated to reflect the changes as per the official developer docs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the vcpkg installation commands in README.md with the official moja global developer documentation, focusing on the two missing commands mentioned in the issue. Update README.md so the FLINT.Example and GCBM package-install instructions reflect the current documentation and no longer produce the reported error.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.