adding readme

Author: AntoineBuirey

builder-tool/pack.py

@@ -5,7 +5,7 @@ class Builder(BaseBuilder):
     def Setup(self):
         self.addDirectory('src', 'src/builderTool')
         self.addAndReplaceByPackageVersion('pyproject.toml')
-        self.addAndReplaceByPackageVersion('readme.md')
+        self.addFile('readme.md')
         self.runCommand(f'{PYTHON} -m pip install --upgrade build')
 
     def Build(self):

builder-tool/readme.md

@@ -1,3 +1,81 @@
-# Builder Tool, for building, testing, publishing, and deploying projects easily.
+# Builder Tool
+
+## Description
+
+Python script for simplify automatic build, tests, publish and deploy of projects.
+- only one file to create
+- based on python classes
+- easy to use
+- compatible with any language
+- usable in CI/CD pipelines
+- clear logs for debugging
+- build from a temporary directory, so the source code is not modified
+- choose the files you want to export from the build
+
+## Usage
+create a file named `pack.py` in the root of your project with the following content:
+
+```python
+from builderTool import BaseBuilder
+
+class Builder(BaseBuilder):
+    def Setup(self):
+        pass
+
+    def Tests(self):
+        pass
+
+    def Docs(self):
+        pass
+        
+    def Build(self):
+        pass
+
+    def BuildTests(self):
+        pass
+
+    def Publish(self):
+        pass
+        
+BaseBuilder.execute()
+```
+
+
+> The `BaseBuilder.execute()` function must be called at the end of the file.
+
+> You can rename the `Builder` class to any name you want.
+
+> You can rename the file to any name you want.
+
+> Remove the methods that you don't need (`Setup` and `Build` are the only required methods).
+
+run the script with:
+```bash
+python pack.py
+```
+
+### Options
+use ```python pack.py --help``` to see the available options:
+
+```
+-h, --help            show this help message and exit
+  --debug               Enable debug messages
+  --deep-debug          Enable deep debug messages
+  --version, -v         show program's version number and exit
+
+Builder options:
+  --no-tests            Do not run tests
+  --no-docs             Do not generate documentation
+  --publish             Publish the package
+  --no-clean            Do not clean temporary files
+  --temp-dir TEMP_DIR   Temporary directory (used to generate the package)
+  --dist-dir DIST_DIR   Distribution directory (where to save the built files)
+  -pv PACKAGE_VERSION, --package-version PACKAGE_VERSION
+                        set the version of the package you want to build
+```
+
+## Installation
+```bash
+pip install https://github.com/GamuNetwork/devtools/releases/download/1.6.8/build_tool-1.6.8-py3-none-any.whl
+```
 
-Current version : {version}

readme.md

@@ -0,0 +1,11 @@
+# available tools
+
+### [builderTool](./builder-tool) - Python script for simplify automatic build, tests, publish and deploy of projects.
+
+### [createModule](./create-module) - Python script for create a new module (game) for GamuNetwork.
+
+### [testReportAssembler](./test-report-assembler) - Merge tests reports from multiple sources into a single report.
+
+### [testReportsPublisher](./test-reports-publisher) - Publish tests reports to a web server.
+
+### [testsExporter](./tests-exporter) - Transform tests reports to html format.