6502/6502bench
1
0
Fork 0
mirror of https://github.com/fadden/6502bench.git synced 2024-12-01 22:50:35 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andy McFadden 2022-05-22 12:59:04 -07:00 committed by GitHub
parent 4c60f329c7
commit 80ffd5f534
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
SourceGen/RuntimeData/README.md
View File

@ -1,12 +1,12 @@
# Runtime Data # # Runtime Data #
Symbol files and analyzer scripts are split into directories by Symbol files and extension scripts are split into directories by
platform manufacturer. platform manufacturer.
The Visual Studio project (RuntimeData.csproj) exists so you can edit A Visual Studio project (`RuntimeData.csproj`) exists in the source tree
scripts with IntelliSense and error highlighting. Everything here is so you can edit scripts with IntelliSense and error highlighting.
distributed as source, not in compiled form; all compilation occurs at Everything in this directory is distributed as source, not in compiled
run time. form; all compilation occurs at run time.
## SystemDefs.json ## ## SystemDefs.json ##
@ -16,7 +16,7 @@ The following fields are mandatory:
* Name - Short name that identifies the system. * Name - Short name that identifies the system.
* GroupName - Short string used to group common items together in the UI. * GroupName - Short string used to group common items together in the UI.
* CPU - Type of CPU used. The string must be part of the known set * CPU - Type of CPU used. The string must be part of the known set
(see CpuDef.cs) (see CpuDef.cs).
* Speed - Clock rate, in MHz, of the CPU on the system. When multiple * Speed - Clock rate, in MHz, of the CPU on the system. When multiple
speeds are possible, use the most common, favoring NTSC over PAL. speeds are possible, use the most common, favoring NTSC over PAL.
* SymbolFiles - List of platform symbol file identifiers (see below). * SymbolFiles - List of platform symbol file identifiers (see below).
@ -25,31 +25,31 @@ The following fields are mandatory:
The currently-supported parameters are: The currently-supported parameters are:
* load-address=&lt;addr&gt; - Specify the initial load address. The default * `load-address=<addr>` - Specify the initial load address. The default
is 0x1000. is 0x1000.
* entry-flags=&lt;flag-set&gt; - Specify the processor status flag values to * `entry-flags=<flag-set>` - Specify the processor status flag values to
use at entry points. This is intended for use on the 65802/65816, and use at entry points. This is intended for use on the 65802/65816, and
may be one of "emulation", "native-short", and "native-long". The may be one of `emulation`, `native-short`, and `native-long`. The
default is "emulation". default is `emulation`.
* undocumented-opcodes={true|false} - Enable or disable undocumented * `undocumented-opcodes={true|false}` - Enable or disable undocumented
opcodes. They are disabled by default. opcodes. They are disabled by default.
* first-word-is-load-addr={true|false} - If true, the first two bytes of * `first-word-is-load-addr={true|false}` - If true, the first two bytes of
the file contain the load address. the file contain the load address.
* default-text-encoding=&lt;mode&gt; - Specify default character encoding. * `default-text-encoding=<mode>` - Specify default character encoding.
Use "c64-petscii" for PETSCII. The default is low/high ASCII. Use `c64-petscii` for PETSCII. The default is low/high ASCII.
All of these things can be changed after the project has begun, but it's All of these things can be changed after the project has begun, but it's
nice to have them configured in advance. nice to have them configured in advance.
SymbolFiles and ExtensionScripts use file identifiers, which look like SymbolFiles and ExtensionScripts use file identifiers, which look like
"RT:Apple/ProDOS8.sym65". The "RT:" means that the file lives in the "`RT:Apple/ProDOS8.sym65`". The "RT:" means that the file lives in the
RuntimeData directory, and the rest is a partial pathname. Files that RuntimeData directory, and the rest is a partial pathname. Files that
live in the same directory as the project file are prefixed with "PROJ:". live in the same directory as the project file are prefixed with "PROJ:".
All symbol files and extension scripts must live in the RuntimeData All symbol files and extension scripts must live in the RuntimeData
directory or project file directory, or they will not be loaded. directory or project file directory, or they will not be loaded.
All "RT:" identifier paths are relative to the RuntimeData directory. The All "RT:" identifier paths are relative to the RuntimeData directory. The
Group Name is not automatically added. GroupName string is not automatically added.
## Platform Symbol Files and Extension Scripts ## ## Platform Symbol Files and Extension Scripts ##
@ -60,7 +60,7 @@ These are described in the "Advanced Topics" section of the manual
## Misc Files ## ## Misc Files ##
ExportTemplate.html and SGStyle.css are used by SourceGen's HTML export `ExportTemplate.html` and `SGStyle.css` are used by SourceGen's HTML export
feature. feature.
LegalStuff.txt is displayed in the About box. `LegalStuff.txt` is displayed in the About box.