aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorAryadev Chavali <aryadev@aryadevchavali.com>2023-11-03 21:53:27 +0000
committerAryadev Chavali <aryadev@aryadevchavali.com>2023-11-03 21:53:27 +0000
commit92c8f497c8b7a0a3edfd7b38c572c536d1171d68 (patch)
treeb99ad3aa8687729ea5e4db118ab3c49f452b4e93 /README.org
parentb2e3e39a39f3cfb4521d522eeba6cc4792db9479 (diff)
downloadovm-92c8f497c8b7a0a3edfd7b38c572c536d1171d68.tar.gz
ovm-92c8f497c8b7a0a3edfd7b38c572c536d1171d68.tar.bz2
ovm-92c8f497c8b7a0a3edfd7b38c572c536d1171d68.zip
Cleaned up How to build section of README
Diffstat (limited to 'README.org')
-rw-r--r--README.org16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.org b/README.org
index eddf2b8..c894f12 100644
--- a/README.org
+++ b/README.org
@@ -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
assertions about typing and is very simple to target.
* 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
written without use of GNU'isms it shouldn't be an issue to compile
using something like =tcc= or another compiler (look at
[[file:Makefile::CC=gcc][here]] to change the compiler).
To build everything simply run ~make~. This will build:
-+ [[file:lib/inst.c][instruction bytecode system]] which allows one to
- target the VM by writing and reading instruction bytecode
-+ [[file:vm/main.c][VM executable]] which can execute bytecode (your
- =java= executable)
-+ [[file:asm/main.c][Assembler executable]] which can assemble
- compliant assembly code to VM bytecode
++ [[file:lib/inst.c][instruction bytecode system]] which provides
+ object files to target the VM
++ [[file:vm/main.c][VM executable]] which executes bytecode
++ [[file:asm/main.c][Assembler executable]] which assembles compliant
+ assembly code to VM bytecode
+ [[file:examples/][Assembly examples]] which provide some source code
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
corresponding recipe: