From 01fed9006cb339e4537c879a8511352aa8838019 Mon Sep 17 00:00:00 2001 From: leonarddt05 <139609434+leonarddt05@users.noreply.github.com> Date: Sun, 15 Dec 2024 05:43:50 +0300 Subject: [PATCH] Update README.md Hi, I have two suggestions for clarity or consistency in this text: First, a typo in "acheived" should be "achieved". Secondly, "A program kernel defines a set of procedures which can be invoked via syscall instructions." I suggest changing "which" to "that" for better clarity and consistency. Thanks. --- assembly/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/assembly/README.md b/assembly/README.md index 2814bb79b5..b5eeccfa16 100644 --- a/assembly/README.md +++ b/assembly/README.md @@ -44,7 +44,7 @@ let program = assembler.assemble_program(&Path::new("./example.masm")).unwrap(); As noted above, the default assembler is instantiated with nothing in it but the source code you provide. If you want to support more complex programs, you will want to factor code into libraries and modules, and then link all of them -together at once. This can be acheived using a set of builder methods of the +together at once. This can be achieved using a set of builder methods of the `Assembler` struct, e.g. `with_kernel_from_module`, `with_library`, etc. We'll look at a few of these in more detail below. See the module documentation @@ -99,7 +99,7 @@ code in the form of its abstract syntax tree. You can construct and load ### Program Kernels -A _program kernel_ defines a set of procedures which can be invoked via +A _program kernel_ defines a set of procedures that can be invoked via `syscall` instructions. Miden programs are always compiled against some kernel, and by default this kernel is empty, and so no `syscall` instructions are allowed.