Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BUILDING.md #172

Merged
merged 1 commit into from
Mar 31, 2020
Merged

Conversation

rwalker-apple
Copy link
Contributor

@rwalker-apple rwalker-apple commented Mar 31, 2020

Problem

BUILDING.md recommends out as a build output directory, which leads to questions like "why isn't out/ in .gitignore?"

Summary of Changes

move recommended output to build/..., try to shed a bit more light on custom builds

may help address #143

cd build/<CONFIG>
../../configure <CONFIG ARGUMENTS>
```
Where `<CONFIG>` is something that describes what configuration (as described by `<CONFIG ARGUMENTS>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to make these steps part of a script that a user can run to set this up this way?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Makefile-Standalone already embodies that of sorts. I'd be reluctant to be much more prescriptive than that since everyone has slightly different styles of working (in tree, out of tree, etc.).

cd build/<CONFIG>
../../configure <CONFIG ARGUMENTS>
```
Where `<CONFIG>` is something that describes what configuration (as described by `<CONFIG ARGUMENTS>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It looks like you are missing a closing paren after <CONFIG ARGUMENTS>

@woody-apple woody-apple merged commit 111f99c into project-chip:master Mar 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants