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

Add documentation for downloading and using VS Code #197

Merged
merged 5 commits into from
Apr 1, 2020
Merged

Add documentation for downloading and using VS Code #197

merged 5 commits into from
Apr 1, 2020

Conversation

woody-apple
Copy link
Contributor

Problem

We should have some base common instructions for setting up VS Code & Local Builds

Summary of Changes

Documentation updates, aligning tasks with it

#186

@woody-apple woody-apple added the documentation Improvements or additions to documentation label Apr 1, 2020
@woody-apple woody-apple added this to the M4.1 milestone Apr 1, 2020
@woody-apple woody-apple linked an issue Apr 1, 2020 that may be closed by this pull request

[Visual Studio Code](https://code.visualstudio.com/) is a great and simple IDE that can be used to build & develop with for CHIP.

CHIP supports the docker / remote container workflow that Visual Studio Code, and has an container environment setup automatically. You can read more about this workflow [here](https://code.visualstudio.com/docs/remote/containers).
Copy link
Contributor

Choose a reason for hiding this comment

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

This might be missing a word or two after "that...".

Copy link
Contributor

Choose a reason for hiding this comment

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

Also "...a container...".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks!

Copy link
Contributor

@gerickson gerickson left a comment

Choose a reason for hiding this comment

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

A few typos to address; otherwise, looks good.

@woody-apple woody-apple requested a review from gerickson April 1, 2020 18:07
@woody-apple woody-apple changed the title Build documentation Add documentation for downloading and using VS Code Apr 1, 2020
Comment on lines +14 to +15
* Documentation about style is documented in [the style guide](./STYLE_GUIDE.md)
* Additional documentation about more specific files are in the [style folder](./style/)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: this might just be a bit of OCD on my part, but you have 2 links defined here and one includes the the and the other doesn't. Recommend removing the the as that appear to fall inline with the rest of the document.

1. Install [Visual Studio Code](https://code.visualstudio.com/) for your operating system of choice here: <https://code.visualstudio.com/Download>
1. Install [Git](https://git-scm.com/) if you haven't already
1. Git clone the main CHIP repository here: <https://github.com/project-chip/connectedhomeip>
1. Launch Visual Studio Code, and open the cloned folder from
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: remove the from

Copy link
Contributor

@BroderickCarlin BroderickCarlin left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together 🙌

Copy link

@hawk248 hawk248 left a comment

Choose a reason for hiding this comment

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

👍

@woody-apple woody-apple merged commit 37bc19c into project-chip:master Apr 1, 2020
@woody-apple woody-apple deleted the build-documentation branch April 1, 2020 21:06
@woody-apple woody-apple linked an issue Apr 1, 2020 that may be closed by this pull request
mkardous-silabs referenced this pull request in mkardous-silabs/connectedhomeip Nov 2, 2022
… Matter Spec 1.0

Merge in WMN_TOOLS/matter from feature/unify-matter-bridge-alpha2-updates to silabs_1.0

Squashed commit of the following:

commit f681fff382c1b8435f4722e27be7b4c85ec6f874
Author: Jakob Olesen <[email protected]>
Date:   Thu Oct 20 10:47:15 2022 +0200

    Fixed ColorTemperature light support

commit b25a0bfd8c688ef547f5f2a1a8b1db549c31a1ed
Author: Thomas Bowley <[email protected]>
Date:   Wed Oct 19 15:53:11 2022 +0200

    NoJira: Log JSON parse or type errors as warnings and not infos.

commit 336412ce0361764eff20c565f888714a5cc8cee3
Author: Dennis Jensen <[email protected]>
Date:   Wed Oct 19 14:04:50 2022 +0200

    NoJira: Don't map endpoints with only 'Groups' or 'NameAndLocation' clusters in them.

... and 2 more commits
rerasool pushed a commit to SiliconLabs/matter that referenced this pull request Nov 2, 2022
… with latest Matter Spec 1.0

Merge in WMN_TOOLS/matter from feature/unify-matter-bridge-alpha2-updates to silabs_1.0

Squashed commit of the following:

commit f681fff382c1b8435f4722e27be7b4c85ec6f874
Author: Jakob Olesen <[email protected]>
Date:   Thu Oct 20 10:47:15 2022 +0200

    Fixed ColorTemperature light support

commit b25a0bfd8c688ef547f5f2a1a8b1db549c31a1ed
Author: Thomas Bowley <[email protected]>
Date:   Wed Oct 19 15:53:11 2022 +0200

    NoJira: Log JSON parse or type errors as warnings and not infos.

commit 336412ce0361764eff20c565f888714a5cc8cee3
Author: Dennis Jensen <[email protected]>
Date:   Wed Oct 19 14:04:50 2022 +0200

    NoJira: Don't map endpoints with only 'Groups' or 'NameAndLocation' clusters in them.

... and 2 more commits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for downloading and using VS Code Main Documentation README.md needs to be flushed out
7 participants