docs: prepare public README and distribute MIT license
build / jvm (push) Canceled after 0s
build / native (macos-15, macos-arm64) (push) Canceled after 0s
build / native (ubuntu-24.04, linux-x86_64) (push) Canceled after 0s
build / native (windows-2025, windows-x86_64) (push) Canceled after 0s

This commit is contained in:
Nilton Constantino
2026-11-16 10:54:46 +00:00
parent dc495b8db5
commit 95c28e2e79
26 changed files with 826 additions and 434 deletions
+1 -1
View File
@@ -1,3 +1,3 @@
---
schemaVersion: 2
lastWork: "0004"
lastWork: "0006"
@@ -0,0 +1,11 @@
---
schemaVersion: 1
id: "ART-0001"
workId: "WRK-0005"
origin: "aie-readme-generic-example.txt"
purpose: "Verificação da remoção de referências ao piloto do README principal"
path: "artifacts/evidence/ART-0001/payload"
sha256: "2990a567d91a0bf785ba0104a335739082bb12a5b84881d5fe2263fc0b6c93ed"
size: 372
author: "agent"
createdAt: "2026-11-16T10:42:10.844235Z"
@@ -0,0 +1 @@
README.md atualizado por solicitação explícita do usuário: remover qualquer menção a Zelda1. O exemplo agora usa um projeto independente genérico, preservando o registro opcional de repositórios. Verificação textual case-insensitive: nenhuma ocorrência de zelda. git diff --check passou. Não foram executados testes de código para esta alteração editorial.
@@ -0,0 +1,12 @@
---
schemaVersion: 1
id: "ART-0002"
workId: "WRK-0005"
origin: "ai-engineering:plans:261a49281886ca015829aea8188f1782b51769430f9351966518b361fc05bc20"
purpose: "Deterministic aggregation of completed Plans and reviewed cancellations;\
\ not semantic verification of prose criteria"
path: "artifacts/evidence/ART-0002/payload"
sha256: "261a49281886ca015829aea8188f1782b51769430f9351966518b361fc05bc20"
size: 283
author: "system:plans"
createdAt: "2026-11-16T10:42:11.801269Z"
@@ -0,0 +1,10 @@
{
"schemaVersion" : 1,
"workId" : "WRK-0005",
"inputHash" : "93311e3a086147c0f89260e689c7a898c1d53d570dfe3c84cf5e18441f72cb19",
"plans" : [ {
"id" : "PLN-0001",
"revision" : 4,
"sha256" : "06fa822257b8e28bde476f039662eb4e0fd03b6e386cae2341f54e12809772e4"
} ]
}
@@ -0,0 +1,18 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0005"
title: "Generalizar o exemplo do README"
decisions: []
steps: []
status: "OPEN"
author: "agent"
createdAt: "2026-11-16T10:42:08.483231Z"
revision: 1
previousHash: null
updatedAt: "2026-11-16T10:42:08.483231Z"
updatedBy: "agent"
changeReason: "Plan created"
documentVersion: 2
---
@@ -0,0 +1,28 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0005"
title: "Generalizar o exemplo do README"
decisions: []
steps:
- id: "TSK-0001"
title: "Remover menções ao piloto e verificar o texto"
description: ""
acceptanceCriteria:
- "Ausência de Zelda no README principal e diff sem problemas."
dependsOn: []
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:42:09.327263Z"
status: "OPEN"
author: "agent"
createdAt: "2026-11-16T10:42:08.483231Z"
revision: 2
previousHash: "444d521aff97d934726525ab1f9301fb94d2c43127a2793eea70681783849b5d"
updatedAt: "2026-11-16T10:42:09.327301Z"
updatedBy: "agent"
changeReason: "Step added"
documentVersion: 2
---
@@ -0,0 +1,29 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0005"
title: "Generalizar o exemplo do README"
decisions: []
steps:
- id: "TSK-0001"
title: "Remover menções ao piloto e verificar o texto"
description: ""
acceptanceCriteria:
- "Ausência de Zelda no README principal e diff sem problemas."
dependsOn: []
status: "COMPLETED"
result: "Exemplo generalizado; nenhuma menção a Zelda no README e diff verificado."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:42:11.238817Z"
status: "ACTIVE"
author: "agent"
createdAt: "2026-11-16T10:42:08.483231Z"
revision: 3
previousHash: "f341d8a5039502303731a262142507d464f7f2230fe55680e3e2a6cda2e53413"
updatedAt: "2026-11-16T10:42:11.238840Z"
updatedBy: "agent"
changeReason: "Exemplo generalizado; nenhuma menção a Zelda no README e diff verificado."
documentVersion: 2
---
@@ -0,0 +1,29 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0005"
title: "Generalizar o exemplo do README"
decisions: []
steps:
- id: "TSK-0001"
title: "Remover menções ao piloto e verificar o texto"
description: ""
acceptanceCriteria:
- "Ausência de Zelda no README principal e diff sem problemas."
dependsOn: []
status: "COMPLETED"
result: "Exemplo generalizado; nenhuma menção a Zelda no README e diff verificado."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:42:11.238817Z"
status: "COMPLETED"
author: "agent"
createdAt: "2026-11-16T10:42:08.483231Z"
revision: 4
previousHash: "925be5be3a029500776938845b9a86252ce01b50ca263863587bc569a3bc0205"
updatedAt: "2026-11-16T10:42:11.552679Z"
updatedBy: "system:plans"
changeReason: "All required steps completed; reviewed cancellations retained"
documentVersion: 2
---
@@ -0,0 +1,61 @@
---
schemaVersion: 1
id: "WRK-0005"
title: "Remover referência ao piloto do README"
description: ""
goal: "Manter o README principal genérico, sem menções a Zelda1."
motivation: ""
constraints: []
acceptanceCriteria:
- "README.md não contém menções a Zelda e preserva a orientação sobre registro opcional\
\ de repositórios."
status: "COMPLETED"
createdAt: "2026-11-16T10:42:07.528745Z"
updatedAt: "2026-11-16T10:42:11.822288Z"
author: "agent"
repositories:
- repositoryId: "ai-engineering"
path: "."
head: "dc495b8db570909402cb6fd3a309986a7770688c"
dirty: false
discussions: []
decisions: []
artifacts:
- "ART-0001"
- "ART-0002"
plans:
- "PLN-0001"
completions:
- at: "2026-11-16T10:42:11.822288Z"
by: "system:plans"
summary: "All required Plans completed; requester=agent"
humanApproved: false
scopeHash: "da13428a698eee289da82ca367a6ef62954a72cbcc8af0c124ef25aa33b72b0c"
criteria:
- criterion: 1
text: "README.md não contém menções a Zelda e preserva a orientação sobre registro\
\ opcional de repositórios."
evidence:
- "ART-0002"
integrations: []
noIntegrationReason: "Canonical changes and execution results are recorded in the\
\ Plan step evidence"
origin: "SYSTEM_PLANS"
delegation: null
aggregation:
receipt: "ART-0002"
inputHash: "93311e3a086147c0f89260e689c7a898c1d53d570dfe3c84cf5e18441f72cb19"
requester: "agent"
requestId: "527bb6b2-29f7-49f9-9010-c38919008c7f"
events:
- action: "COMPLETE"
by: "system:plans"
reason: "All required Plans completed; requester=agent"
at: "2026-11-16T10:42:11.822288Z"
archived: false
topics: []
surveys: []
dispositions: []
agentRuns: []
epic: false
---
@@ -0,0 +1,11 @@
---
schemaVersion: 1
id: "ART-0001"
workId: "WRK-0006"
origin: "aie-public-readme-evidence.txt"
purpose: "Verificação de onboarding público, links e distribuição da licença MIT"
path: "artifacts/evidence/ART-0001/payload"
sha256: "de124b047f5f08c13b570d0a4afba3ac8f9185c929e034b5c98e62a7c4982eda"
size: 3071
author: "agent"
createdAt: "2026-11-16T10:52:12.676232Z"
@@ -0,0 +1,48 @@
WRK-0006 — README público e licença MIT
Pedido explícito: melhorar o README de um projeto público com licença MIT, preservando a remoção anterior de referências ao piloto.
README reescrito em inglês, com apresentação, capacidades, instalação JVM/nativa, início rápido, repositórios genéricos, integração com agentes, compatibilidade, desenvolvimento, documentação, contribuição e licença. Detalhes operacionais extensos foram substituídos por links aos guias existentes. Não há referências a pilotos, projetos privados, caminhos pessoais ou servidor Git privado no README.
LICENSE adicionado com o texto MIT e titular Nilton Constantino (nome constante da autoria Git), ano 2026. A escolha MIT foi expressamente fornecida pelo usuário. Jar/bootJar incluem META-INF/LICENSE; ZIP/TAR nativos incluem LICENSE ao lado de README e docs.
Verificado agora:
- 24 links locais/âncoras resolvidos.
- Início rápido executado como escrito, incluindo a função POSIX para JAR e troca de diretório, em projeto temporário isolado.
- Exemplos api/web executados com repositórios Git descartáveis, sem tocar repositórios reais.
- Configuração dos adaptadores Codex/Claude e diagnóstico de compatibilidade executados no projeto temporário, sem chamadas a modelos.
- ./gradlew bootJar nativeDistZip nativeDistTar -x nativeCompile --console=plain passou. O executável nativo existente foi reempacotado; não foi alegada nova compilação nativa.
- JAR contém o LICENSE exato; ZIP/TAR contêm LICENSE e README idênticos aos fontes atuais.
- git diff --check passou; aie project validate retornou valid=true, issues=[].
Não foi reexecutada a suíte completa de código para esta alteração editorial/metadados de empacotamento. Os exemplos de build nativo/SDKMAN não foram repetidos; foram conferidos contra a configuração versionada e a compilação nativa já executada nesta sessão. agent doctor não é exigido na verificação porque a presença de CLIs de terceiros é opcional; as opções documentadas foram conferidas no --help.
Resultados e hashes:
{
"demo": "/var/folders/0t/tfsqc14j5wbgh9h4s4dytwb00000gq/T/aie-public-readme-p7_y0y9h",
"localLinks": 24,
"shellBlocks": 9,
"quickStartPassed": true,
"repositoryExamplePassed": true,
"agentConfigurationPassed": true,
"compatibilityPassed": true,
"privateReferencesFound": false,
"packages": {
"build/libs/ai-engineering-0.1.0.jar": {
"license": "META-INF/LICENSE"
},
"build/distributions/ai-engineering-0.1.0-mac-os-x-aarch64.tar.gz": {
"license": "LICENSE",
"readmeMatchesSource": true
},
"build/distributions/ai-engineering-0.1.0-mac-os-x-aarch64.zip": {
"license": "LICENSE",
"readmeMatchesSource": true
}
},
"readmeLines": 230,
"readmeSha256": "0cc20053e0874aac59c7c8a77dc9535a7b8ae5a96cb806188e925bdfe85f1caa",
"licenseSha256": "975eef35ea2ca6532c53302a8bf202b99231cc7387ebbb022b1af1d58e4852b6"
}
build.gradle.kts SHA-256: 5a386507208dee521f99043f62d758b580a6d278ed22d045ee82d0cc6305a5dd
@@ -0,0 +1,12 @@
---
schemaVersion: 1
id: "ART-0002"
workId: "WRK-0006"
origin: "ai-engineering:plans:eee36d8122bbad8bbd8013f823b3e6112b1db0d75cc2ef4c84437a83290bbd9a"
purpose: "Deterministic aggregation of completed Plans and reviewed cancellations;\
\ not semantic verification of prose criteria"
path: "artifacts/evidence/ART-0002/payload"
sha256: "eee36d8122bbad8bbd8013f823b3e6112b1db0d75cc2ef4c84437a83290bbd9a"
size: 283
author: "system:plans"
createdAt: "2026-11-16T10:52:15.068458Z"
@@ -0,0 +1,10 @@
{
"schemaVersion" : 1,
"workId" : "WRK-0006",
"inputHash" : "a0f9e8fe82ef06b289a0a825802a7f6d4fab02d3f1788831f1d7a18991f61b3e",
"plans" : [ {
"id" : "PLN-0001",
"revision" : 7,
"sha256" : "a177b558f456203fcb509c245289441056b4a6e8e1857dcff38bb59e0f96864b"
} ]
}
@@ -0,0 +1,13 @@
---
schemaVersion: 1
id: "DSC-0001"
workId: "WRK-0006"
discussionId: "main"
kind: "NOTE"
author: "agent"
createdAt: "2026-11-16T10:46:53.622119Z"
respondsTo: null
documentVersion: 2
---
Autorização explícita do usuário: melhorar README para projeto público com licença MIT, preservando a remoção anterior de referências ao piloto. O repositório ainda não tem LICENSE; incluir o texto MIT e empacotá-lo com JAR/arquivos nativos torna a seção de licença concreta. Não publicar, criar releases, alterar código de produção ou reabrir Works concluídos.
@@ -0,0 +1,18 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps: []
status: "OPEN"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 1
previousHash: null
updatedAt: "2026-11-16T10:46:54.025777Z"
updatedBy: "agent"
changeReason: "Plan created"
documentVersion: 2
---
@@ -0,0 +1,29 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:46:55.295769Z"
status: "OPEN"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 2
previousHash: "c307352921d4ad34a76366e46a406d299803595d0ed42bd49b311d675eb7a5a9"
updatedAt: "2026-11-16T10:46:55.295824Z"
updatedBy: "agent"
changeReason: "Step added"
documentVersion: 2
---
@@ -0,0 +1,41 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:46:55.295769Z"
- id: "TSK-0002"
title: "Verificar exemplos, links e conteúdo dos pacotes"
description: ""
acceptanceCriteria:
- "Exemplos executam em projeto descartável; links locais resolvem; JAR/ZIP/TAR\
\ contêm licença."
dependsOn:
- "TSK-0001"
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:46:57.015487Z"
status: "OPEN"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 3
previousHash: "a04985fefab638200c4ce0a604695e4656bd0e37fcefed1a493b4cdb950314fc"
updatedAt: "2026-11-16T10:46:57.015506Z"
updatedBy: "agent"
changeReason: "Step added"
documentVersion: 2
---
@@ -0,0 +1,41 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "ACTIVE"
result: "Revisão pública do README autorizada pelo usuário."
evidence: []
updatedAt: "2026-11-16T10:46:58.089024Z"
- id: "TSK-0002"
title: "Verificar exemplos, links e conteúdo dos pacotes"
description: ""
acceptanceCriteria:
- "Exemplos executam em projeto descartável; links locais resolvem; JAR/ZIP/TAR\
\ contêm licença."
dependsOn:
- "TSK-0001"
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:46:57.015487Z"
status: "ACTIVE"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 4
previousHash: "2e7be384b1e722ae203b1f1f099f0fa2704f48b1f561c7732a8c476cb8d600fb"
updatedAt: "2026-11-16T10:46:58.089043Z"
updatedBy: "agent"
changeReason: "Revisão pública do README autorizada pelo usuário."
documentVersion: 2
---
@@ -0,0 +1,44 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "COMPLETED"
result: "README público genérico e licença MIT implementados, com licença nos artefatos\
\ distribuíveis."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:52:13.092276Z"
- id: "TSK-0002"
title: "Verificar exemplos, links e conteúdo dos pacotes"
description: ""
acceptanceCriteria:
- "Exemplos executam em projeto descartável; links locais resolvem; JAR/ZIP/TAR\
\ contêm licença."
dependsOn:
- "TSK-0001"
status: "OPEN"
result: ""
evidence: []
updatedAt: "2026-11-16T10:46:57.015487Z"
status: "ACTIVE"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 5
previousHash: "10047e4940d55af2d1e10a84ed3544e253ade72b458f5949587dd84e48ed6a60"
updatedAt: "2026-11-16T10:52:13.092296Z"
updatedBy: "agent"
changeReason: "README público genérico e licença MIT implementados, com licença nos\
\ artefatos distribuíveis."
documentVersion: 2
---
@@ -0,0 +1,46 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "COMPLETED"
result: "README público genérico e licença MIT implementados, com licença nos artefatos\
\ distribuíveis."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:52:13.092276Z"
- id: "TSK-0002"
title: "Verificar exemplos, links e conteúdo dos pacotes"
description: ""
acceptanceCriteria:
- "Exemplos executam em projeto descartável; links locais resolvem; JAR/ZIP/TAR\
\ contêm licença."
dependsOn:
- "TSK-0001"
status: "COMPLETED"
result: "Exemplos e 24 links verificados; JAR, ZIP e TAR construídos e licença/README\
\ conferidos; projeto validado."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:52:14.245461Z"
status: "ACTIVE"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 6
previousHash: "b253affe2c17ff68d19f938629610fae31e3d9c2ce9d2cbebbb87eff0b134a14"
updatedAt: "2026-11-16T10:52:14.245480Z"
updatedBy: "agent"
changeReason: "Exemplos e 24 links verificados; JAR, ZIP e TAR construídos e licenç\
a/README conferidos; projeto validado."
documentVersion: 2
---
@@ -0,0 +1,45 @@
---
schemaVersion: 1
id: "PLN-0001"
workId: "WRK-0006"
title: "Documentação pública e licença distribuível"
decisions: []
steps:
- id: "TSK-0001"
title: "Reescrever README e adicionar licença MIT aos pacotes"
description: ""
acceptanceCriteria:
- "Onboarding público conciso, sem projetos privados; LICENSE real incluído na distribuiç\
ão."
dependsOn: []
status: "COMPLETED"
result: "README público genérico e licença MIT implementados, com licença nos artefatos\
\ distribuíveis."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:52:13.092276Z"
- id: "TSK-0002"
title: "Verificar exemplos, links e conteúdo dos pacotes"
description: ""
acceptanceCriteria:
- "Exemplos executam em projeto descartável; links locais resolvem; JAR/ZIP/TAR\
\ contêm licença."
dependsOn:
- "TSK-0001"
status: "COMPLETED"
result: "Exemplos e 24 links verificados; JAR, ZIP e TAR construídos e licença/README\
\ conferidos; projeto validado."
evidence:
- "ART-0001"
updatedAt: "2026-11-16T10:52:14.245461Z"
status: "COMPLETED"
author: "agent"
createdAt: "2026-11-16T10:46:54.025777Z"
revision: 7
previousHash: "57469deddb86109555a6fef9ff3ddf2897da4541801395668b5354c1bf4b8d8e"
updatedAt: "2026-11-16T10:52:14.653491Z"
updatedBy: "system:plans"
changeReason: "All required steps completed; reviewed cancellations retained"
documentVersion: 2
---
@@ -0,0 +1,71 @@
---
schemaVersion: 1
id: "WRK-0006"
title: "Preparar README público e licença MIT"
description: ""
goal: "Apresentar o AIE como projeto público com onboarding claro, exemplos genéricos\
\ e licença MIT explícita."
motivation: ""
constraints:
- "Preservar a remoção de referências ao piloto e os Works concluídos."
acceptanceCriteria:
- "README em inglês apresenta propósito, requisitos, instalação, início rápido, documentaç\
ão e contribuição sem referências a projetos privados ou pilotos."
- "Licença MIT está disponível e acompanhando os artefatos distribuíveis; links e\
\ exemplos públicos são verificados."
status: "COMPLETED"
createdAt: "2026-11-16T10:46:52.759357Z"
updatedAt: "2026-11-16T10:52:15.102260Z"
author: "agent"
repositories:
- repositoryId: "ai-engineering"
path: "."
head: "dc495b8db570909402cb6fd3a309986a7770688c"
dirty: true
discussions:
- "DSC-0001"
decisions: []
artifacts:
- "ART-0001"
- "ART-0002"
plans:
- "PLN-0001"
completions:
- at: "2026-11-16T10:52:15.102260Z"
by: "system:plans"
summary: "All required Plans completed; requester=agent"
humanApproved: false
scopeHash: "74424246dff759a4a7df4f95ea5b8d8a24fff49dfdee651c01ae0630166baf45"
criteria:
- criterion: 1
text: "README em inglês apresenta propósito, requisitos, instalação, início rá\
pido, documentação e contribuição sem referências a projetos privados ou pilotos."
evidence:
- "ART-0002"
- criterion: 2
text: "Licença MIT está disponível e acompanhando os artefatos distribuíveis;\
\ links e exemplos públicos são verificados."
evidence:
- "ART-0002"
integrations: []
noIntegrationReason: "Canonical changes and execution results are recorded in the\
\ Plan step evidence"
origin: "SYSTEM_PLANS"
delegation: null
aggregation:
receipt: "ART-0002"
inputHash: "a0f9e8fe82ef06b289a0a825802a7f6d4fab02d3f1788831f1d7a18991f61b3e"
requester: "agent"
requestId: "93fe06e5-6970-463f-b3f7-f8f477cd8bd1"
events:
- action: "COMPLETE"
by: "system:plans"
reason: "All required Plans completed; requester=agent"
at: "2026-11-16T10:52:15.102260Z"
archived: false
topics: []
surveys: []
dispositions: []
agentRuns: []
epic: false
---