This repository was archived by the owner on Jan 19, 2023. It is now read-only.

Commit d60fb2c

committed

refactoring and update readme.md

1 parent 63053f1 commit d60fb2cCopy full SHA for d60fb2c

File tree

+10

-3

lines changed

+10

-3

lines changed

Lines changed: 10 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,25 @@`
`1`	`1`	`# Python Regex Based Scanner`
`2`		`-an implemention of a lexical analyzer that tokenize a program using some regex rules`
	`2`	`+`
	`3`	`+an "zero dependency" implementation of a lexical analyzer that tokenize a program using only official "re" package.`
`3`	`4`
`4`	`5`	`# Requirements`
	`6`	`+`
`5`	`7`	`Python 3.8`
`6`	`8`
`7`	`9`	`# How to use`
	`10`	`+`
`8`	`11`	`you can just put your rules in to the compiler_cli.py file and use it for yourself.`
`9`		`-`
	`12`	`+`
`10`	`13`	`this is how you can compile your code using compiler_cli.py`
	`14`	`+`
	`15`	`+PS: you need to install [typer](https://pypi.org/project/typer/) to run the compiler_cli.`
	`16`	`+`
`11`	`17`	```sh
`12`	`18`	`python compiler_cli.py path/to/file`
`13`	`19`	```
`14`	`20`
`15`	`21`	`# Example rules`
	`22`	`+`
`16`	`23`	```py
`17`	`24`	`rules = [`
`18`	`25`	`('IF_KW', r'if'),`
`@@ -33,6 +40,6 @@ rules = [`
`33`	`40`	`('EQUAL_OP', r'=='),`
`34`	`41`	`('ASSIGNMENT_OP', r'='),`
`35`	`42`	`('SEMICOLON', r';'),`
`36`		`- ('IDENTIFIER', r'[a-zA-Z_]\w+'),`
	`43`	`+ ('IDENTIFIER', r'[a-zA-Z_]\w*'),`
`37`	`44`	`]`
`38`	`45`	```

Comments

(0)