Skip to content

Commit

Permalink
Restyled by prettier-markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
@restyled-commits
restyled-commits committed Oct 15, 2021
1 parent e1dd074 commit 19c94b7
Show file tree
Hide file tree
Showing 15 changed files with 152 additions and 144 deletions.
35 changes: 17 additions & 18 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

Want to contribute? Great! First, read this page (including the small print at
the end). By submitting a pull request, you represent that you have the right to
license your contribution to the Connectivity Standards Alliance and the community, and agree by
submitting the patch that your contributions are licensed under the
[Apache 2.0 license](./LICENSE). Before submitting the pull request, please make
sure you have tested your changes and that they follow the project guidelines
for contributing code.
license your contribution to the Connectivity Standards Alliance and the
community, and agree by submitting the patch that your contributions are
licensed under the [Apache 2.0 license](./LICENSE). Before submitting the pull
request, please make sure you have tested your changes and that they follow the
project guidelines for contributing code.

# Contributing as an Open Source Contributor

As an open source contributor you can report bugs and request features in the
[Issue Tracker](https://github.com/project-chip/connectedhomeip/issues), as well
as contribute bug fixes and features that do not impact Matter
specification as a pull request. For example: ports of Matter to add APIs
to alternative programming languages (e.g. Java, JS), hardware ports, or an
optimized implementation of existing functionality. For features that impact the
specification, please join Matter work group within the Connectivity Standards Alliance.
The requirements to become an open source contributor of the
as contribute bug fixes and features that do not impact Matter specification as
a pull request. For example: ports of Matter to add APIs to alternative
programming languages (e.g. Java, JS), hardware ports, or an optimized
implementation of existing functionality. For features that impact the
specification, please join Matter work group within the Connectivity Standards
Alliance. The requirements to become an open source contributor of the
[Matter Repository](https://github.com/project-chip/connectedhomeip) are:

- Agree to the [Code of Conduct](./CODE_OF_CONDUCT.md)
Expand All @@ -27,8 +27,8 @@ The requirements to become an open source contributor of the

# Contributing as a Connectivity Standards Alliance Matter Working Group Member

As a participant of the Connectivity Standards Alliance Matter Working Group, you can
attend Working Group meetings, propose changes to the Matter
As a participant of the Connectivity Standards Alliance Matter Working Group,
you can attend Working Group meetings, propose changes to the Matter
specification, and contribute code for approved updates to the specification.
The requirements to become a member of the
[Matter Repository](https://github.com/project-chip/connectedhomeip) are:
Expand Down Expand Up @@ -73,9 +73,8 @@ Matter follows the "Fork-and-Pull" model for accepting contributions.

Setup your GitHub fork and continuous-integration services:

1. Fork the
[Matter repository](https://github.com/project-chip/connectedhomeip) by
clicking "Fork" on the web UI.
1. Fork the [Matter repository](https://github.com/project-chip/connectedhomeip)
by clicking "Fork" on the web UI.

2. All contributions must pass all checks and reviews to be accepted.

Expand Down Expand Up @@ -165,8 +164,8 @@ on occasion.

#### Documentation Best Practices

Matter uses Doxygen to markup (or markdown) all C, C++, Objective C,
Objective C++, Perl, Python, and Java code. Read our
Matter uses Doxygen to markup (or markdown) all C, C++, Objective C, Objective
C++, Perl, Python, and Java code. Read our
[Doxygen Best Practices, Conventions, and Style](https://github.com/project-chip/connectedhomeip/blob/master/docs/style/DOXYGEN.adoc)

#### Submit Pull Request
Expand Down
94 changes: 47 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,22 @@

# What is Matter?

Matter (formerly Project Connected Home over IP, or Project CHIP) is a new Working Group within the Connectivity Standards Alliance (CSA, formerly Zigbee
Alliance). This Working Group plans to develop and promote the adoption of a new,
royalty-free connectivity standard to increase compatibility among smart home
products, with security as a fundamental design tenet.

The goal of the Matter project is to simplify development for
manufacturers and increase compatibility for consumers. The project is built
around a shared belief that smart home devices should be secure, reliable, and
seamless to use. By building upon Internet Protocol (IP), the project aims to
enable communication across smart home devices, mobile apps, and cloud services
and to define a specific set of IP-based networking technologies for device
Matter (formerly Project Connected Home over IP, or Project CHIP) is a new
Working Group within the Connectivity Standards Alliance (CSA, formerly Zigbee
Alliance). This Working Group plans to develop and promote the adoption of a
new, royalty-free connectivity standard to increase compatibility among smart
home products, with security as a fundamental design tenet.

The goal of the Matter project is to simplify development for manufacturers and
increase compatibility for consumers. The project is built around a shared
belief that smart home devices should be secure, reliable, and seamless to use.
By building upon Internet Protocol (IP), the project aims to enable
communication across smart home devices, mobile apps, and cloud services and to
define a specific set of IP-based networking technologies for device
certification.

The CSA officially opened the Matter Working Group on January 17, 2020 and is in the process of
drafting the specification.
The CSA officially opened the Matter Working Group on January 17, 2020 and is in
the process of drafting the specification.

Visit [buildwithmatter.com](https://buildwithmatter.com) to learn more and read
the latest news and updates about the project.
Expand All @@ -44,10 +45,11 @@ the latest news and updates about the project.

Matter is developed with the following goals and principles in mind:

**Unifying:** Matter will produce a new specification, building with and
on top of market-tested, existing technologies.
**Unifying:** Matter will produce a new specification, building with and on top
of market-tested, existing technologies.

**Interoperable:** The specification permits communication between any Matter-certified device, subject to users’ permission.
**Interoperable:** The specification permits communication between any
Matter-certified device, subject to users’ permission.

**Secure:** The specification leverages modern security practices and protocols.

Expand Down Expand Up @@ -83,9 +85,9 @@ transparent to the general public, including to non-members wherever possible.

The Project, as illustrated above, defines the application layer that will be
deployed on devices and controllers as well as the supported IPv6-based networks
to help achieve our interoperability architectural goal. Matter will
initially support Wi-Fi and Thread for core, operational communications and
Bluetooth Low Energy (BLE) to simplify device commissioning and setup.
to help achieve our interoperability architectural goal. Matter will initially
support Wi-Fi and Thread for core, operational communications and Bluetooth Low
Energy (BLE) to simplify device commissioning and setup.

The Application Layer can be further broken down seven main components:

Expand Down Expand Up @@ -123,18 +125,17 @@ The Application Layer can be further broken down seven main components:

# Current Status of Matter

Matter’s design and technical processes are intended to be open and
transparent to the general public, including to Work Group non-members wherever
possible. The availability of this GitHub repository and its source code under
an Apache v2 license is an important and demonstrable step to achieving this
commitment.
Matter’s design and technical processes are intended to be open and transparent
to the general public, including to Work Group non-members wherever possible.
The availability of this GitHub repository and its source code under an Apache
v2 license is an important and demonstrable step to achieving this commitment.

Matter endeavors to bring together the best aspects of market-tested
technologies and to redeploy them as a unified and cohesive whole-system
solution. The overall goal of this approach is to bring the benefits of Matter
to consumers and manufacturers as quickly as possible. As a result, what
you observe in this repository is an implementation-first approach to the
technical specification, vetting integrations in practice.
to consumers and manufacturers as quickly as possible. As a result, what you
observe in this repository is an implementation-first approach to the technical
specification, vetting integrations in practice.

The Matter repository is growing and evolving to implement the overall
architecture. The repository currently contains the security foundations,
Expand All @@ -146,34 +147,33 @@ scalability.

# How to Contribute

We welcome your contributions to Matter. Read our
contribution guidelines [here](./CONTRIBUTING.md).
We welcome your contributions to Matter. Read our contribution guidelines
[here](./CONTRIBUTING.md).

# Building and Developing in Matter

Instructions about how to build Matter can be found
[here](./docs/README.md).
Instructions about how to build Matter can be found [here](./docs/README.md).

# Directory Structure

The Matter repository is structured as follows:

| File / Folder | Contents |
| -------------------------------------- | ---------------------------------------------------------------------------------------- |
| `build/` | Build system support content and build output directories |
| [BUILDING.md](docs/guides/BUILDING.md) | More detailed information on configuring and building Matter for different targets |
| `CODE_OF_CONDUCT.md` | Code of Conduct for Matter, and contributions to it |
| [CONTRIBUTING.md](./CONTRIBUTING.md) | Guidelines for contributing to Matter |
| `docs/` | Documentation, including [guides](./docs/guides) |
| `examples/` | Example firmware applications that demonstrate use of the Matter technology |
| `integrations/` | Third party integrations related to this project |
| `integrations/docker/` | Docker scripts and Dockerfiles |
| `LICENSE` | Matter [License file](./LICENSE) (Apache 2.0) |
| `BUILD.gn` | Top level GN build file |
| `README.md` | This file |
| `src/` | Implementation of Matter |
| `third_party/` | Third-party code used by Matter |
| `scripts/` | Scripts needed to work with the Matter repository |
| File / Folder | Contents |
| -------------------------------------- | ---------------------------------------------------------------------------------- |
| `build/` | Build system support content and build output directories |
| [BUILDING.md](docs/guides/BUILDING.md) | More detailed information on configuring and building Matter for different targets |
| `CODE_OF_CONDUCT.md` | Code of Conduct for Matter, and contributions to it |
| [CONTRIBUTING.md](./CONTRIBUTING.md) | Guidelines for contributing to Matter |
| `docs/` | Documentation, including [guides](./docs/guides) |
| `examples/` | Example firmware applications that demonstrate use of the Matter technology |
| `integrations/` | Third party integrations related to this project |
| `integrations/docker/` | Docker scripts and Dockerfiles |
| `LICENSE` | Matter [License file](./LICENSE) (Apache 2.0) |
| `BUILD.gn` | Top level GN build file |
| `README.md` | This file |
| `src/` | Implementation of Matter |
| `third_party/` | Third-party code used by Matter |
| `scripts/` | Scripts needed to work with the Matter repository |

# License

Expand Down
10 changes: 5 additions & 5 deletions docs/PROJECT_FLOW.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ repository.

### Issues

Matter uses issues as simple problem descriptions or feature requests. In general,
all work contributed to the repository in the form of pull requests (PR) should
be under the auspices of some open issue. This may seem onerous and in some
cases duplicative, so consider these guidelines when deciding whether to you can
get away with not creating an issue:
Matter uses issues as simple problem descriptions or feature requests. In
general, all work contributed to the repository in the form of pull requests
(PR) should be under the auspices of some open issue. This may seem onerous and
in some cases duplicative, so consider these guidelines when deciding whether to
you can get away with not creating an issue:

- Trivial fixes: issues can function as TODO lists, simple reminders that
something should be addressed. Sometimes, though, the work required to fix
Expand Down
Loading

0 comments on commit 19c94b7

Please sign in to comment.