From c351fa969d9981cfd54eae51ed1d45b4dbb80325 Mon Sep 17 00:00:00 2001 From: Andy McFadden Date: Mon, 7 Jun 2021 17:49:23 -0700 Subject: [PATCH] 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. --- README.md | 22 +++++++++------------- SourceGen/RuntimeData/Help/index.html | 6 ++++-- SourceGen/RuntimeData/Help/tutorials.html | 5 +++++ docs/main.css | 4 ++-- 4 files changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 85df785..f929c7b 100644 --- a/README.md +++ b/README.md @@ -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 ## diff --git a/SourceGen/RuntimeData/Help/index.html b/SourceGen/RuntimeData/Help/index.html index 389836a..6139e6c 100644 --- a/SourceGen/RuntimeData/Help/index.html +++ b/SourceGen/RuntimeData/Help/index.html @@ -15,8 +15,8 @@ and 65816 code. The official web site is https://6502bench.com/.

-

If you want to dive right in, try the -tutorials.

+

If you want to get up to speed quickly, start with the +tutorials.

Contents

diff --git a/SourceGen/RuntimeData/Help/tutorials.html b/SourceGen/RuntimeData/Help/tutorials.html index 0fd6d4f..8d7e4cc 100644 --- a/SourceGen/RuntimeData/Help/tutorials.html +++ b/SourceGen/RuntimeData/Help/tutorials.html @@ -13,6 +13,11 @@

6502bench SourceGen: Tutorials

Back to index

+

NOTE: this tutorial has been superseded by +content on the 6502bench web site. Visit +https://6502bench.com/sgtutorial/.

+

 

+

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 diff --git a/docs/main.css b/docs/main.css index 2f9a4bd..3be9b7c 100644 --- a/docs/main.css +++ b/docs/main.css @@ -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;