6502/6502bench
1
0
Fork 0
mirror of https://github.com/fadden/6502bench.git synced 2024-12-02 13:51:36 +00:00
Code Issues Projects Releases Wiki Activity
e42bb2d262
6502bench/docs/sgtutorial/using-sourcegen.html

221 lines
9.2 KiB
HTML
Raw Normal View History

Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<!-- START: /head-incl.html -->
<!-- common head elements -->
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"
integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<link rel="stylesheet" href="../main.css"/>
<!-- END: /head-incl.html -->
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<title>Using SourceGen - SourceGen Tutorial</title>
</head>
<body>
<div id="masthead">
<!-- START: /masthead-incl.html -->
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<!--<div class="masthead-title" style="background-image: url('images/screenshot-mainwin.png');">-->
<div class="masthead-title">
6502bench
</div>
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<!-- END: /masthead-incl.html -->
</div>
<div id="topnav">
<!-- START: /topnav-incl.html active:#topnav-sgtutorial -->
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<!-- top navigation bar contents -->
<nav>
<a id="topnav-home" href=".././">HOME</a>
<a id="topnav-sgtutorial" class="active" href="../sgtutorial">SourceGen Tutorial</a>
<a id="topnav-menuicon" href="javascript:void(0);" class="icon" onclick="toggleSidenav()">
<i class="fa fa-bars"></i>
</a>
</nav>
<script>
// Sidenav toggle function.
//
// Use a jQuery function to toggle the sidenav bar. The initial state
// is undefined / inherited, so it will pop in and out as the screen
// resizes around the "large" breakpoint.
function toggleSidenav() {
$("#sidenav").toggle("fast");
}
</script>
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<!-- END: /topnav-incl.html -->
</div>
<div id="sidenav">
<!-- START: sidenav-incl.html active:#sidenav-using-sourcegen -->
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<!-- side navigation bar contents -->
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<ul>
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<li id="sidenav-index"><a href="./">Introduction</a></li>
<li id="sidenav-about-disasm"><a href="about-disasm.html">About Disassembly</a></li>
<li id="sidenav-using-sourcegen" class="active"><a href="using-sourcegen.html">Using SourceGen</a>
<ul>
<li id="sidenav-moving-around"><a href="moving-around.html">Moving Around</a></li>
<li id="sidenav-simple-edits"><a href="simple-edits.html">Simple Edits</a></li>
<li id="sidenav-labels-symbols"><a href="labels-symbols.html">Labels &amp; Symbols</a></li>
<li id="sidenav-editing-data"><a href="editing-data.html">Editing Data Operands</a></li>
<li id="sidenav-generating-code"><a href="generating-code.html">Generating Code</a></li>
</ul></li>
<li id="sidenav-digging-deeper"><a href="digging-deeper.html">Digging Deeper</a>
<ul>
<li id="sidenav-string-formatting"><a href="string-formatting.html">String Formatting</a></li>
<li id="sidenav-local-variables"><a href="local-variables.html">Local Variables</a></li>
<li id="sidenav-inline-data"><a href="inline-data.html">Inline Data</a></li>
<li id="sidenav-odds-ends"><a href="odds-ends.html">Odds &amp; Ends</a></li>
</ul></li>
<li id="sidenav-advanced-topics"><a href="advanced-topics.html">Advanced Topics</a>
<ul>
<li id="sidenav-address-tables"><a href="address-tables.html">Address Tables</a></li>
<li id="sidenav-extension-scripts"><a href="extension-scripts.html">Extension Scripts</a></li>
<li id="sidenav-visualizations"><a href="visualizations.html">Visualizations</a></li>
</ul></li>
</ul>
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<!-- END: sidenav-incl.html -->
</div>
<div id="main">
<h2>Using SourceGen</h2>
<div class="grid-container">
<div class="grid-item-text">
<p>This first section covers the basics of working with SourceGen: how to
move around, make edits, generate code, and so on.
SourceGen has some unusual features, so it's worth reading through this
even if you've used other disassemblers.</p>
<p>You can't do anything useful until you open an existing project or
create a new one, so we'll start there.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-text">
<p>A SourceGen project is always associated with a data file, which
holds part or all of the program being disassembled.
For simplicity, the project is given the same name as the data file, with
<code>.dis65</code> on the end.
No part of the data file is included in the project file, so you need
to keep both files in the same place.
If the program you're disassembling was split into more than one data
file, you'll need a separate project file for each.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-image">
<img src="images/t1-fresh-install.png" alt="t1-fresh-install"/>
</div>
<div class="grid-item-text">
<p>To start a new project, launch SourceGen, and click on the
"Start New Project" button on
the initial screen, or use <samp>File &gt; New</samp>. This opens the "New Project"
window, which lets you specify the target system and data file.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-image">
<img src="images/t1-new-project.png" alt="t1-new-project"/>
</div>
<div class="grid-item-text">
<p>Choosing a target system, such as Apple //e or Commodore 64, will
create a project configured with the appropriate CPU and options.
If nothing in the list matches the file you want to work on,
there are "generic" entries for each
of the primary CPU varieties (6502, 65C02, W65C02, and 65816). If
you're unsure, just take your best guess. It's easy to change things after the
project has been started.</p>
<p>The area on the right side of the window has a list of the files, scripts,
and optional features that will be enabled for the
selected system. The various items here will be explained in more
detail later on.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-image">
<img src="images/t1-new-tutorial1.png" alt="t1-new-tutorial1"/>
</div>
<div class="grid-item-text">
<p>For this tutorial, we're going to use "<samp>Generic 6502</samp>",
near the bottom of the list.</p>
<p>The other thing we need to do here is select the data file to be
disassembled. Click <samp>Select File</samp>, navigate to the <samp>Examples</samp>
directory in the SourceGen installation directory, open <samp>Tutorial</samp>,
and select <samp>Tutorial1</samp>.
<p>Click <samp>OK</samp> to create the project.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-text">
<p>The first thing you should do after creating a new project is save it.
Some features create or load files from the directory where the project
file lives, so we want to establish that. Use <samp>File &gt; Save</samp>
or <kbd class="key">Ctrl+S</kbd> to save it, with the default name
(<kbd>Tutorial1.dis65</kbd>), in the directory where the data file lives.</p>
<p>(It's okay to create the project in the installation directory. You
don't need to work off of a copy of the data file; SourceGen doesn't modify
it, so you don't have to worry about trashing the example data.)</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-image">
<img src="images/t1-settings.png" alt="t1-settings"/>
</div>
<div class="grid-item-text">
<p>The disassembly display can be tailored to your personal
preferences. Use <samp>Edit &gt; Settings</samp> to open the
settings editor. You can change fonts, upper/lower case, text
delimiters, line wrapping, pseudo-op names, and more. There
are "quick set" buttons on some screens that allow you to make the
output resemble various popular assemblers.</p>
</div>
</div>
<div class="grid-container">
<div class="grid-item-text">
<p>All app settings are local to your system, and do not affect
the project in any way. If somebody else opens the same project,
they may see entirely different pseudo-ops and upper-case choices,
based on their own personal preferences.
(The settings that affect projects are accessed through a
different screen, via <samp>Edit &gt; Project Properties</samp>.)</p>
<p>For now, you can leave everything set to default values.</p>
</div>
</div>
</div> <!-- #main -->
<div id="prevnext">
<a href="about-disasm.html" class="btn-previous">&laquo; Previous</a>
<a href="moving-around.html" class="btn-next">Next &raquo;</a>
</div>
<div id="footer">
<!-- START: /footer-incl.html -->
Add ${ROOT} substitution Doesn't really affect the pages on the web, but it's easier to preview them in the filesystem when linked to "../main.css" rather than "/main.css". The common portion of the <head> section is now in a separate "include" file. Added some indentation to masthead/topnav/sidenav so it looks nicer in the merged source listing.
2021-06-28 20:37:26 +00:00
<hr/>
<p>Copyright 2021 faddenSoft</p>
<!-- <p id="screen-size"></p>
<script>
var w = window.innerWidth;
var h = window.innerHeight;
var x = document.getElementById("screen-size");
x.innerHTML = "DEBUG: initial window size " + w + "x" + h;
</script> -->
Execute scripts This change applies the substitution scripts on the HTML files, replacing away the jQuery load() calls with the actual file contents, and setting the correct URLs to the prev/next buttons.
2021-06-08 00:14:16 +00:00
<!-- END: /footer-incl.html -->
</div>
</body>
</html>
Reference in New Issue Copy Permalink