From cf2eaa9c6c1fc1a8c95e2f1a688d45ffd2d8c11c Mon Sep 17 00:00:00 2001
From: Florian <1technophile@users.noreply.github.com>
Date: Wed, 1 Jul 2020 09:24:53 -0500
Subject: [PATCH] [DOC] Add support methods and contributors (#646)
* [DOC] Add support methods and contributors link
---
.all-contributorsrc | 33 --------------------------------
CONTRIBUTORS.md | 23 ----------------------
README.md | 34 +++++++++++----------------------
docs/.vuepress/config.js | 1 +
docs/participate/development.md | 1 +
docs/participate/support.md | 6 ++++++
6 files changed, 19 insertions(+), 79 deletions(-)
delete mode 100644 .all-contributorsrc
delete mode 100644 CONTRIBUTORS.md
create mode 100644 docs/participate/support.md
diff --git a/.all-contributorsrc b/.all-contributorsrc
deleted file mode 100644
index e54ab75..0000000
--- a/.all-contributorsrc
+++ /dev/null
@@ -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
-}
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
deleted file mode 100644
index b1469b3..0000000
--- a/CONTRIBUTORS.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-[](#contributors-)
-
-
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-
-
-
-
-
-
-
-
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
\ No newline at end of file
diff --git a/README.md b/README.md
index bb5778f..698a240 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,4 @@
[](https://community.openmqttgateway.com)
-
-[](#contributors-)
-
[](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 :
-
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-
-
-
-
-
-
-
-
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
\ No newline at end of file
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 9c8dfc0..c152654 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -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']
diff --git a/docs/participate/development.md b/docs/participate/development.md
index 7e182a7..105993e 100644
--- a/docs/participate/development.md
+++ b/docs/participate/development.md
@@ -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
diff --git a/docs/participate/support.md b/docs/participate/support.md
new file mode 100644
index 0000000..47ea585
--- /dev/null
+++ b/docs/participate/support.md
@@ -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)
\ No newline at end of file
