1
0
mirror of https://github.com/fadden/6502bench.git synced 2024-11-04 15:05:03 +00:00
6502bench/docs
Andy McFadden 4e5c34f457 Binary includes
This adds a new data format option, "binary include", that takes a
filename operand.  When assembly sources are generated, the section
of file is replaced with an appropriate pseudo-op, and binary files
are generated that hold the file contents.  This is a convenient way
to remove large binary blobs, such as music or sound samples, that
aren't useful to have in text form in the sources.

Partial pathnames are allowed, so you can output a sound blob to
"sounds/blather.bin".  For safety reasons, we don't allow the files
to be created above the project directory, and existing files will
only be overwritten if they have a matching length (so you don't
accidentally stomp on your project file).

The files are not currently shown in the GenAsm dialog, which lets
you see a preview of the generated sources.  The hex dump tool
can do this for the (presumably rare) situations where it's useful.

A new regression test, 20300-binary-include, has been added.  The
pseudo-op name can be overridden on-screen in the settings.

We don't currently do anything new for text/HTML exports.  It might
be useful to generate an optional appendix with a hex dump of the
excised sections.

(issue #144)
2024-05-31 14:22:39 -07:00
..
images Move web site from gh-pages to master branch 2021-06-05 11:08:36 -07:00
sgmanual Binary includes 2024-05-31 14:22:39 -07:00
sgtutorial Rename menu item 2024-04-19 14:16:30 -07:00
block-repl.py Add "suggestions" page to tutorial 2021-08-03 15:09:23 -07:00
CNAME Create CNAME 2021-06-05 11:07:14 -07:00
incl-footer.html Tweak web page include structure 2021-07-10 18:48:42 -07:00
incl-head.html Tweak web page include structure 2021-07-10 18:48:42 -07:00
incl-masthead.html Tweak web page include structure 2021-07-10 18:48:42 -07:00
incl-topnav.html Tweak web page include structure 2021-07-10 18:48:42 -07:00
index.html Tweak web site 2021-11-21 11:23:24 -08:00
main.css Don't strip topnav on narrow devices 2021-06-23 13:32:04 -07:00
README.md Update README 2021-06-08 13:14:14 -07:00

This is the project web site, served through GitHub Pages. The URL https://6502bench.com/ is mapped here. Any change checked in to this part of the tree is (almost) immediately visible on the web.

Many of the pages share common elements: masthead, top nav bar, side nav bar, and footer. These are inserted by a Python script (block-repl.py) that must be run whenever one of the "-incl" files changes.