Skip to content

Adding a small build tip to the quick start instructions #123

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.

Sign up for GitHub

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

Merged
PawelWMS merged 1 commit into from
Sep 21, 2020
Merged

Adding a small build tip to the quick start instructions #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions toolkit/docs/building/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ By default all build commands are executed from inside the `./toolkit` folder.
A few one-time steps can be run now (they will re-run automatically later if needed)

Remote files are generally only available for release branches.

**IMPORTANT:** HEAD of many branches is not guaranteed to build successfully. To avoid build issues it is recommended to check out the `[BRANCH-NAME]-stable` tag.

Example: to safely build the `1.0` branch check out the `1.0-stable` tag.

```bash
# Get the source code
git clone https://github.com/microsoft/CBL-Mariner.git
Expand Down