MiSTer Manual

Community created YouTube tutorials, interviews and helpful online information guides.
8tpercent
Posts: 16
Joined: Sat Jan 09, 2021 2:35 pm
Has thanked: 3 times
Been thanked: 8 times

MiSTer Manual

Unread post by 8tpercent »

Here's a useful manual being updated for all cores:

https://github.com/adreeve/MiSTerManual ... Manual.pdf

As it's on github you can add/correct:

https://github.com/adreeve/MiSTerManual/
User avatar
Newsdee
Top Contributor
Posts: 830
Joined: Mon May 25, 2020 1:07 am
Has thanked: 98 times
Been thanked: 209 times

Re: MiSTer Manual

Unread post by Newsdee »

This is a great effort! The keyboard on the Apple II should probably be a //e though (it has more keys).
keilmillerjr
Posts: 47
Joined: Wed Mar 24, 2021 12:52 pm
Has thanked: 3 times
Been thanked: 6 times

Re: MiSTer Manual

Unread post by keilmillerjr »

Correction: Neo geo aes didn't have a cd attachment. It was a separate console from the aes.
akeley
Top Contributor
Posts: 1303
Joined: Mon May 25, 2020 7:54 pm
Has thanked: 416 times
Been thanked: 399 times

Re: MiSTer Manual

Unread post by akeley »

Nice, though Amiga's omission is a big gap, similar to this one its based on: MiSTer Computer Cheat Sheet v1.8.8 FAQ

I wonder if it would be possible to add the essence of these manuals to OSD as a "Help" option.
User avatar
jlancaster86
Posts: 147
Joined: Sat Jun 27, 2020 1:33 pm
Has thanked: 129 times
Been thanked: 35 times

Re: MiSTer Manual

Unread post by jlancaster86 »

Nice work, but is a PDF really the way to go? Would it not be better to add this information to the respective cores on the MiSTer wiki?
User avatar
redsteakraw
Posts: 244
Joined: Sun May 24, 2020 11:19 pm
Has thanked: 1 time
Been thanked: 40 times

Re: MiSTer Manual

Unread post by redsteakraw »

Nice content but it looks like it was a word doc, and the Typesetting doesn't look great. I would love to help port this to Asciidoc to get a better output Asciidoc is like Markdown but less limited and scales to be able to make textbooks. Github also does native asciidoc rendering so you would be able to read the whole thing from github directly! The PDF exports from asciidoc look amazing, you could also export to html and other formats. Furthermore you can edit the whole document from a simple text editor like notepad so the barrier to making changes is very low. It also works better with version control like git so managing changes and commits from other users would be easier. Asciidoc also allows for external files so each core could have it's own file which could all be imported in the Huge every core manual but you could also re use those filer and make a console manual or a computer manual all without having to change anything!
Fear is the mind killer!
User avatar
redsteakraw
Posts: 244
Joined: Sun May 24, 2020 11:19 pm
Has thanked: 1 time
Been thanked: 40 times

Re: MiSTer Manual

Unread post by redsteakraw »

jlancaster86 wrote: Sun Apr 11, 2021 11:09 am Nice work, but is a PDF really the way to go? Would it not be better to add this information to the respective cores on the MiSTer wiki?
PDF is good if you want to print it out or share it or keep for offline uses. PDFs could also if rendered correctly can have superior typesetting to a webpage.
Fear is the mind killer!
keilmillerjr
Posts: 47
Joined: Wed Mar 24, 2021 12:52 pm
Has thanked: 3 times
Been thanked: 6 times

Re: MiSTer Manual

Unread post by keilmillerjr »

redsteakraw wrote: Sun Apr 11, 2021 1:23 pm
jlancaster86 wrote: Sun Apr 11, 2021 11:09 am Nice work, but is a PDF really the way to go? Would it not be better to add this information to the respective cores on the MiSTer wiki?
PDF is good if you want to print it out or share it or keep for offline uses. PDFs could also if rendered correctly can have superior typesetting to a webpage.
Github uses markdown and can be community driven. You can print as well as save as a pdf with most modern computers. No one needs a summary of every type of computer or console printed, so the argument is irrelevant.
User avatar
redsteakraw
Posts: 244
Joined: Sun May 24, 2020 11:19 pm
Has thanked: 1 time
Been thanked: 40 times

Re: MiSTer Manual

Unread post by redsteakraw »

keilmillerjr wrote: Sun Apr 11, 2021 4:31 pm Github uses markdown and can be community driven. You can print as well as save as a pdf with most modern computers. No one needs a summary of every type of computer or console printed, so the argument is irrelevant.
Yes a wiki may be fine for one page but if you want to send a person a single file and have everything they can reference offline then a pdf is fine. I would say that most typsetting of wiki markdown ends up as HTML and it looks like garbage. This version was typed in Word so it also looks like garbage but it has potential to be great. Having an offline backup manual or simplified quick reference is a good idea.
Fear is the mind killer!
keilmillerjr
Posts: 47
Joined: Wed Mar 24, 2021 12:52 pm
Has thanked: 3 times
Been thanked: 6 times

Re: MiSTer Manual

Unread post by keilmillerjr »

Perhaps each core having a readme.md or man file installed on the mister would be better suited.?
User avatar
aberu
Core Developer
Posts: 1144
Joined: Tue Jun 09, 2020 8:34 pm
Location: Longmont, CO
Has thanked: 244 times
Been thanked: 388 times
Contact:

Re: MiSTer Manual

Unread post by aberu »

keilmillerjr wrote: Mon Apr 12, 2021 12:54 pm Perhaps each core having a readme.md or man file installed on the mister would be better suited.?
I like this method personally. A proper markdown viewer (like https://brettterpstra.com/2015/08/21/md ... -terminal/) can be installed on the the MiSTer linux image and potentially a new option in the OSD for help could be added which is populated by the readme.md from each core automatically.
birdybro~
User avatar
redsteakraw
Posts: 244
Joined: Sun May 24, 2020 11:19 pm
Has thanked: 1 time
Been thanked: 40 times

Re: MiSTer Manual

Unread post by redsteakraw »

So man pages are using Groff / Troff typesetting, you can convert to it from Markdown but it is far better to use Asciidoc for those purposes as it isn't as limited and more things map 1:1 without any hacks. So a good Asciidoc manual can be outputted to pdf, html, manpage, epub and more! Github also renders asciidoc so you can use it instead of Markdown which I would recommend doing as Markdown is great for simple things but breaks down when you want to do anything complicated.
Fear is the mind killer!
User avatar
aberu
Core Developer
Posts: 1144
Joined: Tue Jun 09, 2020 8:34 pm
Location: Longmont, CO
Has thanked: 244 times
Been thanked: 388 times
Contact:

Re: MiSTer Manual

Unread post by aberu »

Very true, all good points.
birdybro~
Post Reply