added readme

This commit is contained in:
pca006132 2021-06-25 12:28:33 +08:00
parent 4902f9f645
commit 6996bb5ac1
1 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# nac3 compiler
This repository contains:
- nac3core: Core compiler library, containing type-checking, static analysis (in
the future) and code generation.
- nac3embedded: Integration with CPython runtime.
- nac3standalone: Standalone compiler tool.
The core compiler would know nothing about symbol resolution, host variables
etc. The nac3embedded/nac3standalone library would provide (implement) the
symbol resolver to the core compiler for resolving the type and value for
unknown symbols. The core compiler would only type check classes and functions
requested by the nac3embedded/nac3standalone lib (the API should allow the
caller to specify which methods should be compiled). After type checking, the
compiler would analyse the set of functions/classes that are used and perform
code generation.
Symble resolver:
Str -> Nac3Type
Str -> Value
value could be integer values, boolean values, bytes (for memcpy), function ID
(full name + concrete type)