Skip to content

Commit c7189a5

Browse files
committed
adiciona readme
1 parent eb15a64 commit c7189a5

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ create-compiler:
88
docker-compose exec antlr antlr4 -lib grammars -o lib -visitor -Xexact-output-dir grammars/ExprLexer.g4 -Dlanguage=JavaScript
99

1010
compile:
11-
npm run start --f $(file)
11+
node ./build/src/main.js --f $(file)
1212

1313
install:
1414
npm install

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Trabalho de Introdução e Compiladores
2+
3+
### Como instalar o compilador
4+
5+
> Atenção: É necessário ter o Node.js instalado no computador antes de executar os passos abaixo. Para instalar o Node.js basta seguir os [passos de instalação no site oficial da ferramenta](https://nodejs.dev/).
6+
7+
1. Instale as dependências do projeto através do comando `make install`
8+
2. Execute o comando `make build-project` para buildar o projeto.
9+
10+
### Como executar um dos arquivos de demonstração?
11+
12+
Temos três programas de exemplo escritos para execução do compilador. Eles ficam localizados dentro da pasta `./codes` do projeto. Para executar um dos 3 programas, basta escolher um arquivo dentre as 3 opções a seguir:
13+
14+
1. file1.lcc
15+
2. file2.lcc
16+
3. file3.lcc
17+
18+
Após escolher um, copie o nome do arquivo e execute o seguinte comando: `make compile file=<<nome-do-arquivo>>`, exemplo `make compile file=file1.lcc`.

0 commit comments

Comments
 (0)