Skip to content

Commit 087bc5c

Browse files
committed
docs: update README structure and usage instructions
1 parent bc8a01e commit 087bc5c

2 files changed

Lines changed: 32 additions & 25 deletions

File tree

README.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,33 @@ O emulador pode ser usado de duas formas principais:
1010

1111
-----
1212

13+
## Estrutura do Projeto
14+
15+
```
16+
Runtime Errors Emulator/
17+
├── src/
18+
│ ├── stack_overflow.cpp
19+
│ ├── segmentation_fault.cpp
20+
│ ├── buffer_overflow.cpp
21+
│ ├── memory_leak.cpp
22+
│ ├── race_condition.cpp
23+
│ ├── deadlock.cpp
24+
│ └── core_dump.cpp
25+
├── Dockerfile.emulator
26+
├── emulator.sh
27+
├── run.sh
28+
├── Makefile
29+
└── README.md
30+
```
31+
32+
> `task-definition.json` e `.github` são parte da Github Action.
33+
34+
> `.gitignore` e `.vscode` são, respectivamente, para versionamento git e configuração do VS Code.
35+
36+
> `Dockerfile.script` serve apenas para execução alternativa em container local e script direto.
37+
38+
-----
39+
1340
## Pré-requisitos
1441

1542
* [Docker](https://www.docker.com/products/docker-desktop/) instalado e em execução.
@@ -22,17 +49,7 @@ O emulador pode ser usado de duas formas principais:
2249

2350
Antes de executar, você precisa construir a imagem Docker. Escolha o modo de operação que deseja usar.
2451

25-
### Modo 1: Script no Host
26-
27-
Esta imagem contém apenas os programas compilados. O script `error_emulator.sh` no seu computador irá gerenciá-la.
28-
29-
```bash
30-
docker build -t meus-programas-cpp .
31-
```
32-
33-
*(Este comando usa o `Dockerfile` padrão)*
34-
35-
### Modo 2: Menu Interativo no Contêiner
52+
### Modo: Menu Interativo no Contêiner
3653

3754
Esta imagem contém os programas compilados e também o script de menu, que é definido como o ponto de entrada principal.
3855

@@ -47,17 +64,7 @@ docker build -f Dockerfile.emulator -t error_emulator .
4764

4865
## Execução e Uso
4966

50-
### Modo 1: Usando o Script no Host
51-
52-
Este modo é ideal para executar erros específicos de forma rápida e isolada, sem o menu.
53-
54-
1. **Execute o erro desejado:**
55-
```bash
56-
docker run --rm -it error_emulator ./deadlock
57-
```
58-
*(Substitua `./deadlock` pelo executável do erro que deseja testar)*
59-
60-
### Modo 2: Usando o Menu Interativo no Contêiner
67+
### Modo 1: Usando o Menu Interativo no Contêiner
6168
Este modo é para quem deseja iniciar o contêiner manualmente. É útil para entender os passos que o script `run.sh` automatiza.
6269

6370
1. **Inicie o contêiner com as configurações necessárias:**
@@ -74,7 +81,7 @@ Este modo é para quem deseja iniciar o contêiner manualmente. É útil para en
7481

7582
-----
7683

77-
### Modo 3: Fluxo de Trabalho Automatizado (All-in-One)
84+
### Modo 2: Fluxo de Trabalho Automatizado (All-in-One)
7885

7986
Este modo é a forma mais simples e profissional de executar a demonstração completa de erros que exigem permissões especiais, como o `core_dumped`. Ele automatiza a construção e a execução do contêiner, além da configuração interna necessária, em um único comando.
8087

@@ -144,9 +151,9 @@ Este projeto foi desenvolvido em equipe, com as seguintes responsabilidades:
144151

145152
* **Rômulo Duarte:**
146153
* Implementação do `segmentation_fault`
147-
* Estruturação de pastas do projeto
154+
* Criação do menu CLI `emulator.sh`
148155
* Configuração do ambiente Docker (`Dockerfile`)
149-
* Criação do menu
156+
* Estruturação de pastas do projeto
150157

151158
* **Luís & Rômulo:**
152159
* Configuração do pipeline de CI/CD (GitHub Actions e AWS)
File renamed without changes.

0 commit comments

Comments
 (0)