Skip to content

Commit

Permalink
πŸ“ Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexW00 committed Dec 22, 2021
1 parent 9ee9b1d commit f726594
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ A tiny Javascript/Typescript compiler written in vanilla Typescript as a hobby p

## Usage

### Configure ./main.ts
### Configure your attribute grammar

1. Define your lexical rules in ./config/attributeGrammar/lexicalRuleset.ts
2. Define your syntax rules in ./config/attributeGrammar/syntaxRuleset.ts
3. Define your semantic rules in ./config/attributeGrammar/semanticRuleset.ts
4. Create a new Compiler object (import from "ts/compiler/Compiler.ts", requires Lexer.ts, Parser.ts, CodeGenerator.ts)
5. Use compiler.compile("input string) to compile

### Configure ./main.ts

1. Create a new Compiler object (import from "ts/compiler/Compiler.ts", requires Lexer.ts, Parser.ts, CodeGenerator.ts)
2. Use compiler.compile("input string) to compile

### Run

Expand Down

0 comments on commit f726594

Please sign in to comment.