[camel-kamelets] branch main updated: Added generation and validation instructions in README.md

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git


The following commit(s) were added to refs/heads/main by this push:
     new bd965a7  Added generation and validation instructions in README.md
bd965a7 is described below

commit bd965a7f5aef23fea7e4cf4df5cc6a256d92e653
Author: Andrea Tarocchi <an...@gmail.com>
AuthorDate: Thu Dec 16 14:52:34 2021 +0100

    Added generation and validation instructions in README.md
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 94c2a6e..f795515 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,25 @@ Kamelets in this repository are intended to be generic connectors that any exter
 
 All Kamelets posted here will be subject to the scrutiny of the Apache Camel PMC to assess their compliance with the ecosystem and, in any case, they **MUST** be in line with the general [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
 
+### Building and validating
+
+Building the project:
+```bash
+$ ./mvnw clean install
+```
+
+**IMPORTANT:** After adding or modifying a kamelet remember to generate:
+```bash
+$ cd script/generator
+$ go run . ../../kamelets/ ../../docs/modules/ROOT/
+```
+and validate:
+```bash
+$ cd script/validator
+$ go run go run . ../../kamelets/
+```
+be sure that there aren't reported ERRORS.
+
 ### General Format
 
 Kamelets **MUST** be provided in the *Kubernetes YAML* format, i.e. they **MUST** be resources that can be applied on a cluster using the Kubernetes `kubectl` CLI.