diff --git a/SourceGen/RuntimeData/README.md b/SourceGen/RuntimeData/README.md index b735edc..67e7a16 100644 --- a/SourceGen/RuntimeData/README.md +++ b/SourceGen/RuntimeData/README.md @@ -1,12 +1,12 @@ # Runtime Data # -Symbol files and analyzer scripts are split into directories by +Symbol files and extension scripts are split into directories by platform manufacturer. -The Visual Studio project (RuntimeData.csproj) exists so you can edit -scripts with IntelliSense and error highlighting. Everything here is -distributed as source, not in compiled form; all compilation occurs at -run time. +A Visual Studio project (`RuntimeData.csproj`) exists in the source tree +so you can edit scripts with IntelliSense and error highlighting. +Everything in this directory is distributed as source, not in compiled +form; all compilation occurs at run time. ## SystemDefs.json ## @@ -16,7 +16,7 @@ The following fields are mandatory: * Name - Short name that identifies the system. * 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 - (see CpuDef.cs) + (see CpuDef.cs). * Speed - Clock rate, in MHz, of the CPU on the system. When multiple speeds are possible, use the most common, favoring NTSC over PAL. * SymbolFiles - List of platform symbol file identifiers (see below). @@ -25,31 +25,31 @@ The following fields are mandatory: The currently-supported parameters are: - * load-address=<addr> - Specify the initial load address. The default + * `load-address=` - Specify the initial load address. The default is 0x1000. - * entry-flags=<flag-set> - Specify the processor status flag values to + * `entry-flags=` - Specify the processor status flag values to 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 - default is "emulation". - * undocumented-opcodes={true|false} - Enable or disable undocumented + may be one of `emulation`, `native-short`, and `native-long`. The + default is `emulation`. + * `undocumented-opcodes={true|false}` - Enable or disable undocumented 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. - * default-text-encoding=<mode> - Specify default character encoding. - Use "c64-petscii" for PETSCII. The default is low/high ASCII. + * `default-text-encoding=` - Specify default character encoding. + 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 nice to have them configured in advance. 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 live in the same directory as the project file are prefixed with "PROJ:". All symbol files and extension scripts must live in the RuntimeData directory or project file directory, or they will not be loaded. 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 ## @@ -60,7 +60,7 @@ These are described in the "Advanced Topics" section of the manual ## 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. -LegalStuff.txt is displayed in the About box. +`LegalStuff.txt` is displayed in the About box.