[DOC] Add support methods and contributors (#646)
* [DOC] Add support methods and contributors link
This commit is contained in:
Florian authored and GitHub committed
1 parent
c490c026d9
commit
cf2eaa9c6c
6 files changed
+19
-79
No files matched your search
@@ -1,33 +0,0 @@
|
||||
{
|
||||
"files": [
|
||||
"CONTRIBUTORS.md"
|
||||
],
|
||||
"imageSize": 100,
|
||||
"commit": false,
|
||||
"contributors": [
|
||||
{
|
||||
"login": "Alomon31",
|
||||
"name": "Alomon31",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/59569925?v=4",
|
||||
"profile": "https://github.com/Alomon31",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "HannesDi",
|
||||
"name": "Hans-Jürgen Dinges",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/14812047?v=4",
|
||||
"profile": "https://github.com/HannesDi",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
}
|
||||
],
|
||||
"contributorsPerLine": 7,
|
||||
"projectName": "OpenMQTTGateway",
|
||||
"projectOwner": "1technophile",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"skipCi": true
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/Alomon31"><img src="https://avatars0.githubusercontent.com/u/59569925?v=4" width="100px;" alt=""/><br /><sub><b>Alomon31</b></sub></a><br /><a href="https://github.com/1technophile/OpenMQTTGateway/commits?author=Alomon31" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/HannesDi"><img src="https://avatars1.githubusercontent.com/u/14812047?v=4" width="100px;" alt=""/><br /><sub><b>Hans-Jürgen Dinges</b></sub></a><br /><a href="https://github.com/1technophile/OpenMQTTGateway/commits?author=HannesDi" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-enable -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
@@ -1,7 +1,4 @@
|
||||
[](https://community.openmqttgateway.com)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
[](https://gitlicense.com/license/1technophile/OpenMQTTGateway)
|
||||
[](https://github.com/1technophile/OpenMQTTGateway/releases)
|
||||
|
||||
@@ -12,36 +9,27 @@
|
||||
|
||||
**Questions, support please don't open an issue, go first to the [docs](https://docs.openmqttgateway.com) and if you not find your answer go to [the community forum](https://community.openmqttgateway.com)**
|
||||
|
||||
# OpenMQTTGateway
|
||||
[](https://community.openmqttgateway.com)
|
||||
|
||||
## Download
|
||||
Download OpenMQTTGateway from the [releases page](https://github.com/1technophile/OpenMQTTGateway/releases)
|
||||
|
||||
## Documentation
|
||||
The documentation is [here](https://docs.openmqttgateway.com)
|
||||
|
||||
The reference sheet, with the list of all functions, pinouts is [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=0)
|
||||
|
||||
## Compatible devices and parts
|
||||
|
||||
A list of supported devices is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079), door/window sensors, PIR sensors, smoke detectors, weather stations...
|
||||
|
||||
A list of compatible components to build your gateway is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277), nodemcu, esp32, emitters and receivers...
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful [people](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors) who helped OpenMQTTGateway
|
||||
|
||||
## Support
|
||||
If you want to buy a coffee or other beverage so as to give me some support, here is a way to do it :
|
||||
|
||||
<a href="https://www.buymeacoffee.com/1technophile" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/Alomon31"><img src="https://avatars0.githubusercontent.com/u/59569925?v=4" width="100px;" alt=""/><br /><sub><b>Alomon31</b></sub></a><br /><a href="https://github.com/1technophile/OpenMQTTGateway/commits?author=Alomon31" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-enable -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
@@ -95,6 +95,7 @@ module.exports = {
|
||||
title: '6 - Participate 💻', // required
|
||||
sidebarDepth: 1, // optional, defaults to 1
|
||||
children: [
|
||||
'participate/support',
|
||||
'participate/development',
|
||||
'participate/community',
|
||||
['https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt','License']
|
||||
|
||||
@@ -6,6 +6,7 @@ agree to follow the code of conduct below
|
||||
[code of conduct](https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md)
|
||||
|
||||
[code style guide](https://google.github.io/styleguide/cppguide.html#Formatting)
|
||||
So as to format automaticaly your document you have to add the "clang-Format" extension to VSCode, once done you can format the code by doing a right click into the code file window and clicking "Format document".
|
||||
|
||||
Fork the [development branch](https://github.com/1technophile/OpenMQTTGateway/tree/development), then clone the repo
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
If you like the project and/or used it please consider supporting it! It can be done in different ways:
|
||||
* Helping other users in the [community](https://community.openmqttgateway.com)
|
||||
* [Contribute](development) to the [code](https://github.com/1technophile/OpenMQTTGateway) or the [documentation](https://docs.openmqttgateway.com)
|
||||
* Buy devices or parts from the [devices list](https://docs.google.com/spreadsheets/u/1/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079=), the devices and parts linked use affiliated links.
|
||||
* Donate or sponsor the project [developpers](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors)
|
||||
* Make a video or a blog article about what you have done with [OpenMQTTGateway](https://docs.openmqttgateway.com)
|
||||
Reference in new issue
Block a user