Skip to content

Commit 61c9633

Browse files
committed
docs: mise à jour de la documentation et du README pour ark.yml et BCASL
1 parent 0230256 commit 61c9633

5 files changed

Lines changed: 17 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,10 @@ python3 pycompiler_ark.py build --lock latest.lock # Rebuild from lock file
9393
# Execution
9494
python3 pycompiler_ark.py run bcasl # Execute BCASL pipeline
9595
python3 pycompiler_ark.py run bcasl --list-plugins # List active plugins
96-
```
9796

9897
# GUI
99-
10098
python3 pycompiler_ark.py gui # Launch modern IDE-like GUI
10199
python3 pycompiler_ark.py gui --legacy # Launch classic GUI
102-
103100
```
104101

105102
### Developer Commands
@@ -129,7 +126,7 @@ python3 pycompiler_ark.py init --entry main.py --json
129126

130127
---
131128

132-
## How it works
129+
## Documentation
133130

134131
- [Contributing guide](docs/contributing.md)
135132
- [How to create an engine](docs/how_to_create_an_engine.md)
@@ -139,8 +136,8 @@ python3 pycompiler_ark.py init --entry main.py --json
139136

140137
## Configuration
141138

142-
- **`ark.yml`**: workspace/build exclusion patterns, build entrypoint, and a few workspace-level defaults consumed by BCASL bootstrap.
143-
- **`bcasl.yml`**: plugin enable/disable, order, and timeouts.
139+
- **`ark.yml`**: Project metadata, build entrypoint, build/workspace exclusions, and global BCASL activation.
140+
- **`bcasl.yml`**: Detailed BCASL pipeline configuration, plugin settings, and execution order.
144141

145142
---
146143

docs/ark_main_config.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ build:
2626
data:
2727
- source: assets/
2828
destination: assets/
29+
30+
plugins:
31+
bcasl_enabled: true
2932
```
3033
3134
## Build Entrypoint
@@ -57,7 +60,7 @@ The fields in `ark.yml` are mapped directly to the `BuildContext` data structure
5760
| `build.data` | `data_mappings` |
5861
| `build.icon` | `icon` |
5962

60-
> **Note**: `workspace.exclude` is exclusive to the GUI workspace view filtering. `build.exclude` is what determines which files are ignored during the actual compilation and BCASL phases.
63+
> **Note**: `workspace.exclude` is exclusive to the GUI workspace view filtering (file explorer). `build.exclude` is what determines which files are ignored during the actual compilation (engine) and BCASL phases.
6164

6265
## Plugins Configuration
6366

docs/dev_docs/ARK_BuildContext_v1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Each dictionary in `data_mappings` follows this structure:
5757
| `project_name` | `project.name` | `project.name` |
5858
| `entry_point` | `project.entry` | `project.entry` |
5959
| `output_dir` | `build.output` | `build.output` |
60-
| `exclude_patterns` | `workspace.exclude` | `workspace.exclude_patterns` |
60+
| `exclude_patterns` | `build.exclude` | `build.exclude` (or `workspace.exclude_patterns` fallback) |
6161
| `data_mappings` | `build.data` | `build.data` |
6262
| `icon` | `build.icon` | `build.icon` |
6363

docs/dev_docs/ARK_Cli_v1.1.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,16 +116,20 @@ project:
116116

117117
workspace:
118118
exclude:
119-
- "tests/**/*"
120119
- "**/__pycache__/**"
121120

122121
build:
123122
engine: nuitka
124123
output: dist/
124+
exclude:
125+
- "tests/**/*"
125126
data:
126127
- source: plugins/
127128
destination: plugins/
128129
icon: assets/icon.ico
130+
131+
plugins:
132+
bcasl_enabled: true
129133
```
130134
131135
---

docs/dev_docs/ARK_Locking_v1.0.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,15 @@ project:
4545
entry: src/main.py # Copied from project.entry
4646

4747
workspace:
48-
exclude_patterns: # Copied from workspace.exclude
48+
exclude_patterns: # Copied from build.exclude (legacy support)
4949
- tests/**/*
5050
- "**/__pycache__/**"
5151

5252
build:
5353
output: dist/ # Copied from build.output
54+
exclude: # Copied from build.exclude
55+
- tests/**/*
56+
- "**/__pycache__/**"
5457
data: # Copied from build.data
5558
- source: assets/
5659
destination: assets/

0 commit comments

Comments
 (0)