Minor changes to README. master origin/HEAD origin/master
authorAaron Taylor <ataylor@subgeniuskitty.com>
Sun, 13 Jun 2021 01:29:13 +0000 (18:29 -0700)
committerAaron Taylor <ataylor@subgeniuskitty.com>
Sun, 13 Jun 2021 01:29:13 +0000 (18:29 -0700)
stdlib/README.md

index 9119b75..b04f08e 100644 (file)
@@ -14,8 +14,8 @@ stack manipulations by allowing easy access to elements deep on the stack.
 Similarly, `slurp` and `spew` help move bulk data between the stack and heap.
 
 User interactions were also targeted. The included `printf` function provides a
 Similarly, `slurp` and `spew` help move bulk data between the stack and heap.
 
 User interactions were also targeted. The included `printf` function provides a
-variety of substitutions to ease user interactions. For user input, `get user
-string` and `atoi` allow easy creation of basic user interfaces.
+variety of substitutions to ease user interactions. For user input,
+`get user string` and `atoi` allow easy creation of basic user interfaces.
 
 The library includes a variety of bitwise logic functions as well as heap
 manipulation functions and a handful of math functions including a random
 
 The library includes a variety of bitwise logic functions as well as heap
 manipulation functions and a handful of math functions including a random
@@ -149,11 +149,11 @@ following reservations:
 ## Heap and Pointers ##
 
 The first 16 heap addresses (`0-15`) are reserved when using the stdlib.
 ## Heap and Pointers ##
 
 The first 16 heap addresses (`0-15`) are reserved when using the stdlib.
-Within that reservation, heap[0] is used by `random` and the block
-heap[1]-heap[15] by the stack rotation subroutines which time-share
+Within that reservation, `heap[0]` is used by `random` and the block
+`heap[1]`-`heap[15]` by the stack rotation subroutines which time-share
 pseudo-registers between the various stdlib subroutines.
 
 pseudo-registers between the various stdlib subroutines.
 
-By convention, chosen since no function other than `random` should use heap[0],
+By convention, chosen since no function other than `random` should use `heap[0],`
 functions which return a pointer will use the address `0` to represent a `NULL`
 pointer.
 
 functions which return a pointer will use the address `0` to represent a `NULL`
 pointer.
 
@@ -176,7 +176,7 @@ For example, to push a 64-bit array of all `1`'s on to the stack we must push
 ## Extending Heap Reservation ##
 
 By default, the stdlib uses the first 16 heap addresses. All heap access (other
 ## Extending Heap Reservation ##
 
 By default, the stdlib uses the first 16 heap addresses. All heap access (other
-than heap[0] as a seed) occurs through `stackrotate` and `stackrotatereverse`.
+than `heap[0]` as a seed) occurs through `stackrotate` and `stackrotatereverse`.
 Edit these functions to increase the stdlib's heap reservation.
 
 The remainder of the stdlib is written to automatically use the new allocation.
 Edit these functions to increase the stdlib's heap reservation.
 
 The remainder of the stdlib is written to automatically use the new allocation.