microsoft / microsoft/pxt

Document local build process

Open
#5,319 9 comments 0 reactions 1 assignee View on GitHub

@darzu is already working on this.

Since Mar 13, 2019.

documentation setup
Dominant language
TypeScript
Stars
2.3k
Forks
641
Avg merge
12h 4m
Merged PRs (30d)
57

Description

As per #5286, cloud building is not the preferred method for doing C++ development. However, the documentation does not reflect this anywhere.

For example, documentation for the pxt command only mentions the --cloud command, and indicates that this forces builds to happen "in the cloud". This implies that the default is to not do that.

Indeed, projects (such as https://github.com/microsoft/pxt-chibitronics#setup) indicate that a local toolchain is required to build, and other projects mention the invalid -yt flag (https://github.com/Microsoft/pxt-calliope#running).

There are a few issues here:

  1. The --localbuild flag should be documented
  2. It should be mentioned that --cloud is default and implied
  3. Nonexistent flags such as -yt should be removed from documentation
  4. It should be mentioned that, when doing C++ development, a local build environment is preferred.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.