Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelkamprath committed Jul 29, 2023
1 parent 2995f96 commit 1f1b1ca
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Changes that are planned but not implemented yet:
* unknown labels

## [Unreleased]
* Added support for negative values in numeric expressions, data type initializations, and constant values

## [0.4.1]
* added `.asciiz` as an equivalent data directive to `.cstr`
Expand All @@ -24,7 +23,9 @@ Changes that are planned but not implemented yet:
* Fixed [reported bug](https://github.com/michaelkamprath/bespokeasm/issues/25) where indirect indexed register operands were not parsed properly.
* Fixed bug that did not sanely handle an instructions operand configuration indicating 0 operands
* Allow predefined constants to labels starting with `_`, which also indicates file scope for code defined labels
* Added MThe Minimal 64 Home Computer example
* Added The Minimal 64 Home Computer example
* Added support for negative values in numeric expressions, data type initializations, and constant values
* Improved several compilation errors.

## [0.4.0]
* Added ability to create preprocessor macros/symbols with `#define` directive. Thes macros can then be used in code. Also added the ability to define preprocessor symbols on the command line and in the instruction set configuration file.
Expand Down
2 changes: 1 addition & 1 deletion examples/slu4-minimal-64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The arguments to the command above are:
* `-p` - indicates that a textual representation of the assembled code should be emitted.
* `-t intel_hex` - Specifies the format of the textual rerpesentation of the compiled code, in this case being Intel Hex. If you ommit this option, the default textual representation of an human-readable listing will be used.
* `-c /path/to/slu4-minimal-64.yaml` - The file path to the **BespokeASM** instruction set configuration for the Minimal 64.
* `/path/to/my-code.min64` - The file path to the Minimal 64 assembly code to be compiled. Here by convention the assembly code has a file extension of `.min64`. While **BespokeASM** can work with any file extension for the code, the convention is used so that code editors know what file type they are editing and thus are able to support syntax highlighting specific to the Minimal 64 assembly syntax. See **BespokeASM**'s documentation on syntax highlighting support for more information.
* `/path/to/my-code.min64` - The file path to the Minimal 64 assembly code to be compiled. Here by convention the assembly code has a file extension of `.min64`. While **BespokeASM** can work with any file extension for the code, the convention is used so that code editors know what file type they are editing and thus are able to support syntax highlighting specific to the Minimal 64 assembly syntax. See [**BespokeASM**'s documentation on syntax highlighting support](https://github.com/michaelkamprath/bespokeasm/wiki/Installation-and-Usage#installing-language-extensions) for more information.

### Instruction Set
Carsten Herting thoroughly documents [the instruction set for the Minimal 64 in his user guide](https://docs.google.com/document/d/1e4hL9Z7BLIoUlErWgJOngnSMYLXjfnsZB9BtlwhTC6U/edit?usp=sharing). All of the documented instructions in their original syntax are implemented in in this **BespokeASM** port. However, **BespokeASM** will be case insensitive when matching instruction mnemonics.
Expand Down

0 comments on commit 1f1b1ca

Please sign in to comment.