oreodave/aal
Archived
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleaned up How to build section of README

Browse Source
This commit is contained in:
Aryadev Chavali
2023-11-03 21:53:27 +00:00
parent b2e3e39a39
commit 92c8f497c8
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.org
View File

@@ -6,22 +6,22 @@ A stack based virtual machine in C11, with a dynamic register setup
which acts as variable space. Deals primarily in bytes, doesn't make which acts as variable space. Deals primarily in bytes, doesn't make
assertions about typing and is very simple to target. assertions about typing and is very simple to target.
* How to build * How to build
Requires =GNU make=, a compliant C11 compiler. Code base has been Requires =GNU make= and a compliant C11 compiler. Code base has been
tested against =gcc= and =clang=, but given how the project has been tested against =gcc= and =clang=, but given how the project has been
written without use of GNU'isms it shouldn't be an issue to compile written without use of GNU'isms it shouldn't be an issue to compile
using something like =tcc= or another compiler (look at using something like =tcc= or another compiler (look at
[[file:Makefile::CC=gcc][here]] to change the compiler). [[file:Makefile::CC=gcc][here]] to change the compiler).
To build everything simply run ~make~. This will build: To build everything simply run ~make~. This will build:
+ [[file:lib/inst.c][instruction bytecode system]] which allows one to + [[file:lib/inst.c][instruction bytecode system]] which provides
target the VM by writing and reading instruction bytecode object files to target the VM
+ [[file:vm/main.c][VM executable]] which can execute bytecode (your + [[file:vm/main.c][VM executable]] which executes bytecode
=java= executable) + [[file:asm/main.c][Assembler executable]] which assembles compliant
+ [[file:asm/main.c][Assembler executable]] which can assemble assembly code to VM bytecode
compliant assembly code to VM bytecode
+ [[file:examples/][Assembly examples]] which provide some source code + [[file:examples/][Assembly examples]] which provide some source code
examples on common programs one may write. Use this to figure out examples on common programs one may write. Use this to figure out
how to write compliant assembly. how to write compliant assembly. Also a good test of both the VM
and assembler.
One may also build each component individually through the One may also build each component individually through the
corresponding recipe: corresponding recipe: