forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull request project-chip#125: V0.4.0 doc update
Merge in WMN_TOOLS/matter from v0.4.0_doc_update to silabs Squashed commit of the following: commit 86ee80df8f4fd45e1b651da721e8ed41306e22f4 Author: Ezra Hale <[email protected]> Date: Tue Oct 4 11:42:39 2022 -0400 closing out the rest of Catherine's comments commit 07e8b9c42662d3251da667ae95df74678f8098d7 Author: Ezra Hale <[email protected]> Date: Tue Oct 4 09:58:02 2022 -0400 Chip-Tool -> chip-tool commit ce0b943a13143873572e67afe16c01150d883f9d Author: Ezra Hale <[email protected]> Date: Tue Sep 27 12:18:33 2022 -0400 updated to address Mathieu's issues in the PR ... and 12 more commits
- Loading branch information
1 parent
459d5c2
commit de574ef
Showing
24 changed files
with
506 additions
and
326 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Silicon Labs Documentation Standards Using Markdown | ||
|
||
## Titles | ||
# This Is a Title | ||
Notice how the main words are capitalized | ||
|
||
## Subsections Look Like This | ||
This is a `##` subsection under a `#` title header. Notice how the words are also capitalized. | ||
|
||
## Lists | ||
|
||
- This is a bulleted list | ||
- Second item in a bulleted list | ||
|
||
1. This is a numbered list | ||
2. Second item in a numbered list | ||
|
||
## Commands | ||
|
||
```shell | ||
$ this is a highlighted command | ||
``` | ||
|
||
```shell | ||
$ if there is a second line it has it's own entry | ||
``` | ||
```shell | ||
$ notice how commands all start with the dollar sign, $, this is to indicate that they are to be used on a command line | ||
``` | ||
## Code | ||
```cpp | ||
This is a code block() { | ||
Not to be confused with a highlighted command as above ^^^ | ||
This should only be used for preformatted code, not for commands. | ||
} | ||
``` | ||
## Notes | ||
> **Note:** This is a note that we want to draw attention to, it is similar to a highlighted command except that it does not generally use `preformatted text`. | ||
## Tables | ||
| col 1 | col 2 | col 3 | | ||
| ----- | ----- | ----- | | ||
| don't do | large tables | they don't | | ||
| format well | or look good | and are | | ||
| difficult | to | maintain | | ||
If you need to do a large table, find some other way to represent the information in .md. You could use HTML but this is also frowned upon for the reason listed below... | ||
## HTML | ||
Try to avoid <br> Using HTML <br> Since it doesn't <br> get picked up <br> by .md translators |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,24 +29,30 @@ | |
On macOS, you must install Xcode from the Mac App Store. The remaining | ||
dependencies can be installed and satisfied using [Brew](https://brew.sh/): | ||
|
||
> `$ brew install openssl pkg-config` | ||
```shell | ||
$ brew install openssl pkg-config | ||
``` | ||
|
||
However, that does not expose the package to `pkg-config`. To fix that, run | ||
something like the following: | ||
|
||
Intel: | ||
|
||
> `$ cd /usr/local/lib/pkgconfig ln -s ../../Cellar/[email protected]/1.1.1g/lib/pkgconfig/* .` | ||
```shell | ||
$ cd /usr/local/lib/pkgconfig ln -s ../../Cellar/[email protected]/1.1.1g/lib/pkgconfig/* . | ||
``` | ||
|
||
where `[email protected]/1.1.1g` may need to be replaced with the actual version of | ||
OpenSSL installed by Brew. | ||
|
||
Apple Silicon: | ||
|
||
> `$ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:"/opt/homebrew/opt/openssl@3/lib/pkgconfig"` | ||
```shell | ||
$ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:"/opt/homebrew/opt/openssl@3/lib/pkgconfig" | ||
``` | ||
|
||
Note: If using MacPorts, `port install openssl` is sufficient to satisfy this | ||
dependency. | ||
|
||
> **Note:** If using MacPorts, `port install openssl` is sufficient to satisfy this dependency. | ||
### Mac OS (Apple Silicon) Users | ||
|
||
|
@@ -56,21 +62,29 @@ those mentioned above. <br> | |
1. Add ARM GCC toolchain to the search path within `bootstrap.sh` by adding this | ||
line of code: | ||
|
||
> `$ export PATH="/Applications/ARM/bin:$PATH"` | ||
```shell | ||
$ export PATH="/Applications/ARM/bin:$PATH" | ||
``` | ||
|
||
2. Users may also have to specify which `pkg-config`/`openssl` to use by adding | ||
these lines of code as well: | ||
|
||
> `$ export PATH="/opt/homebrew/opt/openssl@3/bin:$PATH"` | ||
```shell | ||
$ export PATH="/opt/homebrew/opt/openssl@3/bin:$PATH" | ||
``` | ||
|
||
> `$ export PKG_CONFIG_PATH="/opt/homebrew/opt/openssl@3/lib/pkgconfig"` | ||
```shell | ||
$ export PKG_CONFIG_PATH="/opt/homebrew/opt/openssl@3/lib/pkgconfig" | ||
``` | ||
|
||
### Installing prerequisites on Linux | ||
|
||
On Debian-based Linux distributions such as Ubuntu, these dependencies can be | ||
satisfied with the following: | ||
|
||
> ` $ sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev` | ||
```shell | ||
$ sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev | ||
``` | ||
|
||
## Bootstrapping your source tree (one time) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.