Skip to content

Commit 0f6ee9c

Browse files
📝 docs(README): Add overview section to README for better documentation clarity.
1 parent f2e4c09 commit 0f6ee9c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Codocx é uma ferramenta de linha de comando (CLI) simples e eficiente para automatizar a geração de documentação de qualquer projeto de software, independentemente da linguagem de programação ou stack tecnológica utilizada.
44

5+
## Visão Geral
6+
7+
A documentação é essencial, mas muitas vezes negligenciada. Codocx resolve esse problema ao permitir que desenvolvedores gerem documentação atualizada e acessível com apenas alguns comandos. A ferramenta é compatível com qualquer linguagem de programação, garantindo flexibilidade e eficiência em qualquer ambiente de desenvolvimento.
8+
59
## Execução via CLI
610

711
A CLI do Codocx foi projetada para ser extremamente fácil de usar, permitindo a geração de documentação diretamente a partir da estrutura de código do seu projeto.
@@ -28,10 +32,6 @@ A CLI do Codocx foi projetada para ser extremamente fácil de usar, permitindo a
2832

2933
Caso queira excluir determinados arquivos ou diretórios da geração da documentação, você pode configurar isso editando o arquivo `src/constants/index.ts`.
3034

31-
## Visão Geral
32-
33-
A documentação é essencial, mas muitas vezes negligenciada. Codocx resolve esse problema ao permitir que desenvolvedores gerem documentação atualizada e acessível com apenas alguns comandos. A ferramenta é compatível com qualquer linguagem de programação, garantindo flexibilidade e eficiência em qualquer ambiente de desenvolvimento.
34-
3535
## Requisitos
3636

3737
Antes de começar, certifique-se de que sua máquina atenda aos seguintes requisitos:

0 commit comments

Comments
 (0)