1
0
mirror of https://github.com/fadden/6502bench.git synced 2024-06-27 03:29:28 +00:00

Update docs to point to new tutorial

Replaced the link at the top of the manual.  Remove reference to
old tutorial doc.  Added an obsolescence notice to the top of the
old tutorial.  Updated tutorial message and link in README.

Also, fixed sidenav style.
This commit is contained in:
Andy McFadden 2021-06-07 17:49:23 -07:00
parent a4ba60aafc
commit c351fa969d
4 changed files with 20 additions and 17 deletions

View File

@ -135,8 +135,8 @@ automatically in the directory where the .EXE lives.
You need to have Microsoft .NET Framework v4.6.2 or later installed. Most
people will already have this. If SourceGen doesn't seem to want to start,
download the latest version (currently v4.7.2)
[directly from Microsoft](https://www.microsoft.com/net/download/dotnet-framework-runtime).
download the latest version (currently v4.8)
[directly from Microsoft](https://dotnet.microsoft.com/download/dotnet-framework/net48).
The framework requires Win7 SP1, Win8.1, or Win10 updated through at least
the Anniversary Update (1607). (One user who had trouble with the 4.7.2
installer was able to get the 4.6.2 installer to work.)
@ -154,18 +154,14 @@ may ease the transition to a cross-platform GUI API like Avalonia.)
## Getting Started ##
The best way to get started is by working through the tutorial. Launch
SourceGen, hit F1 to open the user manual in your web browser, then look
for the Tutorial link in the index. Click it and follow the instructions
there. Note this is a "follow along" tutorial, not a "read it" tutorial.
The best way to get started is by working through the tutorial, available
on the [web site](https://6502bench.com/sgtutorial/). I strongly recommend
doing this, as some aspects of SourceGen are non-obvious.
I strongly recommend doing this. Some aspects of SourceGen are non-obvious.
The tutorial is one of several examples included in the SourceGen
distribution. The other directories contain project and data files for
completed disassembly projects alongside the original source code, allowing
a direct comparison between how the code was written and how SourceGen can
display it.
Several examples of completed projects are included in the SourceGen
distribution. Most of these are alongside the original source code,
allowing a direct comparison between how the code was written and how
SourceGen can format and display it.
## About the Code ##

View File

@ -15,8 +15,8 @@
and 65816 code. The official web site is
<a href="https://6502bench.com/">https://6502bench.com/</a>.</p>
<p>If you want to dive right in, try the
<a href="tutorials.html">tutorials</a>.</p>
<p>If you want to get up to speed quickly, start with the
<a href="https://6502bench.com/sgtutorial/">tutorials</a>.</p>
<h2>Contents</h2>
<ul>
@ -178,6 +178,7 @@ and 65816 code. The official web site is
<br/>
<!--
<li><a href="tutorials.html">Tutorials</a>
<ul>
<li><a href="tutorials.html#basic-features">Tutorial #1: Basic Features</a></li>
@ -186,6 +187,7 @@ and 65816 code. The official web site is
<li><a href="tutorials.html#extension-scripts">Tutorial #4: Extension Scripts</a></li>
<li><a href="tutorials.html#visualizations">Tutorial #5: Visualizations</a></li>
</ul></li>
-->
</ul>

View File

@ -13,6 +13,11 @@
<h1>6502bench SourceGen: Tutorials</h1>
<p><a href="index.html">Back to index</a></p>
<p><strong>NOTE:</strong> this tutorial has been superseded by
content on the 6502bench web site. Visit
<a href="tutorials.html">https://6502bench.com/sgtutorial/</a>.</p>
<p>&nbsp;</p>
<p>The tutorials introduce SourceGen and cover some of the basic
features. They skim lightly over some important concepts, like the
difference between numeric and symbolic references, so reading the

View File

@ -156,10 +156,10 @@ kbd.key {
margin: 0;
}
#sidenav li {
padding: 0 0px 1px 0; /* top right bottom left */
padding: 0 0 1px 0; /* top right bottom left */
}
#sidenav ul ul li {
padding: 0 0 1px 10px; /* top right bottom left */
padding: 1px 0 0 10px; /* top right bottom left */
}
#sidenav a {
color: #ffffff;