From fb060cf29d40dcf3e1137aa2d331a0b0aab0f275 Mon Sep 17 00:00:00 2001 From: Alex Robenko Date: Tue, 24 Dec 2024 15:01:40 +1000 Subject: [PATCH] Added "Asking For Help" section to README. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 0188cce4..afd24bcc 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,20 @@ to just clone the sources of this repository and use it without any extra manipulations of looking for the latest stable version among the tags and checking it out. +# Asking For Help +With time the [CommsChampion Ecosystem](https://commschamp.github.io) has grown with both +features and complexity. Sometimes it can become challenging, especially for first time users, +to find a proper way to define the required binary protocol, especially quite complex ones. +The most efficient way to ask for help would be: + +1. forking the official [tutorial](https://github.com/commschamp/cc_tutorial/) project on github +2. create a separate folder (say **howto100**) where the minimal portion of +the required protocol which exposes the encountered problem is defined. +3. [get in touch](#contact-information) providing an info on the forked project and encountered problem. + +The suggested resolution will be provided by a pull request and/or a comment. After the problem +is resolved, the forked project can be deleted. + # Contact Information For bug reports, feature requests, or any other question you may open an issue here in **github** or e-mail me directly to: **arobenko@gmail.com**. I usually