A page per frontend - #48
Merged
Merged
Conversation
The README listed only the SDL2 and the console frontends, and the build instructions for all of them lived in the README. Now there is a Frontends section with the eight of them, each linking to a page with how to build it, how to use it and what it can not do. The libretro pages take the frontend_ prefix as well. The feature list moves to doc/features.md, leaving a summary in the README. The default configuration was wrong in the two places it was written: it listed a parallel card in slot 1 and a mouse in slot 4, which are empty and a Mockingboard, and flags -disk35 and -hd that no longer exist. Both lists now come from -showConfig.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README listed two of the eight frontends and carried the build
instructions for all of them. This adds a Frontends section with the eight,
each linking to a page of its own with how to build it, how to use it and what
it can not do. The per platform build steps move into those pages.
New pages
doc/frontend_sdl2.mda2sdl, the complete one and the one in the releasesdoc/frontend_sdl3.mda2sdl3, no cgo, cross compilesdoc/frontend_console.mdconsole, ANSI on the terminaldoc/frontend_ebiten.mda2ebitendoc/frontend_wasm.mda2wasm, the browserdoc/frontend_fyne.mda2fynedoc/frontend_headless.mdheadless, the command promptThey are written from the code, so they carry things that were not documented
anywhere: the paste with Shift-Insert or Cmd-V, F9, the keys each frontend is
missing, and the commands
headlessactually implements as against the onesits own
helppromises.doc/libretro.mdanddoc/libretro_macos.mdare renamed todoc/frontend_libretro.mdanddoc/frontend_libretro_macos.mdfor theprefix, with their links updated.
Feature list
Moved to
doc/features.md, with a summary and a link left in the README,which is now 90 lines and reads: what it is, features, running it, frontends,
building it.
Fixes on the way
The default configuration was written in two places and both were wrong. They
now come from
izapple2 -showConfig:doc/command_line.mdhad slot 4 empty, it holds a Mockingboard.the flags
-disk35and-hd, which no longer exist. It said the RAMWorkscard has 8Gb, it is 8Mb.
Typos:
witth,wuth,Mockinboard,pass ot the,flags N anv V,inteface,Usefull,dependant of,VidHd. Indoc/cpm65.mdthe fourexamples said
ìzapple, with a grave accent and no2, so none of them couldbe copied and run.
doc/frontend_libretro.mdpointed atizapple2sdl, abinary name that no longer exists.
Not touched
doc/command_line.mduses ```bash fences while every other page usesdoc/usage.txtcome from Go string literals and need a codechange:
nunmberand an unclosed quote inconfiguration.go,sotfswichestwice in
traceBuilder.go,UtratermincardVidexUltraterm.go.frontend/a2wasm/README.mdadvertises a Toggle Speed button and a workinggetDiskInfo, neither of which exists.