README has incomplete build instructions.

Open
#34 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reading the README and the build instructions inside the demo directory, then reproduce the documented make test and make demo commands. Trace the existing make release, make debug, and demo targets to determine which instructions are incomplete. Done means the README and demo instructions describe build commands that work as documented.

Written by the indexing model from the issue text.

Description

2.x

When, following the README, I type make test, I get the message: Please run 'make release' or 'make debug' first

When, again following the README, calling make demo, I get the message: make: Nothing to be done for 'demo'. The build (instructions) inside the demo directory also don't work.

Dominant language
C++
Stars
52
Forks
33
PR merge metrics
No merged PRs in 30d

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.

More from mapbox/vector-tile

All issues in mapbox/vector-tile

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.