Will somebody please write a full and complete manual for DASM?
PixelTwins opened this issue · comments
It's fast and efficient, but I've heard the manual isn't up to date, and even if it is what's there reads more like student notes than a proper manual. It has the potential to be a very useful assembler. Please will somebody write a complete manual with all of its current features?
I'm working on it
This is what I have so far.
I'm looking for any/all missing features, and corrections to the document.
A very good start. 👍
Here are my first remarks:
- The precedence values seem reversed. Highest precedence should have 1. At least that's how its handled in Germany. Maybe its different outside?
- DV/EQM needs a good example
- At the beginning of chapter 5, some pseudo-ops are in lower case.
- Same: "Those that cannot are noted." Does that refer to the following list of pseudo-ops? It is not 100% clear.
I've only JUST started. I wanted to put something up so people didn't duplicate effort, and could contribute to this. There are lots and lots of issues while I sort out formatting, etc. And I plan to include an example for many of the "things" dasm does. I'm using Latex to generate the document.
Here's an update.
dasm20200823.pdf
Looks great!
Wonderful work, Andrew. Latex is perfect... when you're happy with it, we can put that source in github too! 👍
Update. Now with a "Change Log" just after the title page.
dasm20200824.pdf
Wonderful work, Andrew. Latex is perfect... when you're happy with it, we can put that source in github too! 👍
Ready to go. There's a couple of GPL3 .sty files in there - no issue, I think.
I checked that I could load "dasm.tex" and successfully built a PDF using texstudio from that.
dasm.zip
Do you think this documentation / user guide would eventually replace the /doc/dasm.txt file?
That was my hope.
The only thing not included was the prefaces from Matt, Peter and myself.
I've placed dasm.pdf in the /manual folder of the dasm git repo, and copied the LaTeX sources to the /manual/sources subfolder.
I'm wondering why this location, instead of the 'docs' folder?
The welcome text specifically states that docs/manuals are in the 'docs' folder -- and it seems odd to me to have two folders for eseentially the same thing.
The welcome text specifically states that docs/manuals are in the 'docs' folder -- and it seems odd to me to have two folders for eseentially the same thing.
Yes, agree. I moved the manual into the /docs folder, and also changed the dasm main website to link to the new PDF documentation.
Btw: I like how you went from using uppercase DASM to lowercase dasm, even matching the color of the logo :-)
Btw: I like how you went from using uppercase DASM to lowercase dasm...
Grrr! 😈
Awesome! I am very impressed with how responsive that was. The result is excellent. Well done! I am trying to popularise DASM in 64 groups. Thank you. :)
Awesome! I am very impressed with how responsive that was. The result is excellent. Well done! I am trying to popularise DASM in 64 groups. Thank you. :)
Only weeks and weeks of work; no problem! ;)