6502/6502bench
1
0
Fork 0
mirror of https://github.com/fadden/6502bench.git synced 2024-12-31 21:30:59 +00:00
Code Issues Projects Releases Wiki Activity

Add installation notes to README

Browse Source 
Also, add a link to the tutorial near the top of the manual's index
page.
This commit is contained in:
Andy McFadden 2018-10-01 11:09:04 -07:00
parent 62ebe4176f
commit b27accc9d3
2 changed files with 31 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,13 +1,13 @@
# 6502bench #
[Features](#key-features) - [Getting Started](#getting-started) - [About the Code](#about-the-code)
[Features](#key-features) - [Installation](#installation) - [Getting Started](#getting-started) - [About the Code](#about-the-code)
[6502bench](https://6502bench.com/) is a code development "workbench"
for 6502, 65C02, and 65802/65816 code. It currently features one tool,
the SourceGen disassembler.
You can download the source code and build it yourself, or click the
["Releases" tab](https://github.com/fadden/6502bench/releases) for
[Releases tab](https://github.com/fadden/6502bench/releases) for
pre-built downloads.
@ -86,12 +86,31 @@ character sets (e.g. PETSCII). Visit the wiki section for the
[current "TO DO" list](https://github.com/fadden/6502bench/wiki/TO-DO-List).
## Installation ##
There is currently no installer -- just unzip the archive and run the
executable. The data files used by the program are found automatically
based on the path to the .EXE file.
SourceGen relies on the .NET Framework. For Windows, you need to have
Microsoft .NET Framework v4.6.2 or later installed. Many people will already
have this installed. If SourceGen doesn't seem to want to start, download
the latest version (v4.7.2)
[directly from Microsoft](https://www.microsoft.com/net/download/dotnet-framework-runtime).
The framework requires Win7 SP1, Win8.1, or Win10 updated through at least
the Anniversary Update (1607).
In theory, SourceGen can work with Mono under Linux and Mac OS X. It
currently crashes on startup with Mono 5.14.0 on Ubuntu, so it's uncertain
when or if this will work.
## 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 scroll
down near the bottom of the index page. Click on "Tutorials", and follow
the instructions.
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.
The tutorial is one of several examples included in the SourceGen
distribution. The other directories contain project and data files for
@ -105,11 +124,11 @@ display it.
All of the code is written in C# .NET, using the (free to download) Visual
Studio Community 2017 IDE as the primary development environment. The user
interface uses the WinForms API. Efforts have been made to avoid doing
anything Windows-specific, in the hope that the applications will be
straightforward to port to other platforms.
anything Windows-specific, in the hope of running it under Mono.
The solution is called "WorkBench.sln" rather than "6502bench.sln" because
some things in Visual Studio got weird when it didn't start with a letter.
The Solution file is called "WorkBench.sln" rather than "6502bench.sln"
because some things in Visual Studio got weird when it didn't start with a
letter.
The code style is closer to what Android uses than "standard" C#. Lines
are folded to fit 100 columns.

3
SourceGen/RuntimeData/Help/index.html
View File

@ -15,6 +15,9 @@
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">Tutorial</a>.</p>
<h2>Contents</h2>
<ul>
<li><a href="intro.html">Overview</a></li>