cli/q
1
0
Fork 0
Code Issues Pull requests Releases Activity

Improved documentation

Browse source
This commit is contained in:
Eduard Urbach 2024-06-02 15:20:05 +02:00
parent b72e3943a4
commit ec20fd3d3a
Signed by: eduard
GPG key ID: 49226B848C78F6C8
4 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -56,9 +56,15 @@ q build examples/hello --dry
The `Build` type defines all the information needed to start building an executable file.
The name of the executable will be equal to the name of the build directory.
`Run` starts the build which will scan all files in the build directory.
The functions found in the scan will be translated to generic assembler instructions.
All the functions that are required to run the program will be added to final assembler.
`Run` starts the build which will scan all `.q` source files in the build directory.
Every source file is scanned in its own goroutine for performance reasons.
Parallelization here is possible because the order of code in a directory is not significant.
The main function is meanwhile waiting for new function objects to arrive from the scanners.
Once a function has arrived, it will create another goroutine for the function compilation.
The function will then be translated to generic assembler instructions.
All the functions that are required to run the program will be added to the final assembler.
The final assembler resolves label addresses, optimizes the performance and generates the specific x86-64 machine code from the generic instruction set.
The `Run` method is currently not fully implemented.