[Scummvm-devel] Decompiler: Documentation feedback

[Michael Madsen]

Hi all,

I've just finished writing the documentation on the decompiler, and I think it turned out pretty good - but that's easy for me to say, since I wrote it in the first place!

To make sure I didn't miss something important or that I'm not clear enough about certain things, I'd like for as many of you as possible to read through the documentation and tell me what you think - especially if there are any problems.

You can either compile your own copy if you have a LaTeX distribution installed (type "make doc" in the checkout directory or "make" in the documentation directory, and it'll compile to a PDF), or you can download a PDF of the current version from http://birdiesoft.dk/doc.pdf - I'll update that as I make changes to the documentation.

I know 23 pages seems like a lot, but even if you only read a small part, that can still help.

Ideally, I'd like to get all the major issues worked out before GSoC ends, so to make sure there's enough time for that, I'd like to hear from you no later than *Friday the 13th*. Of course, I'll still accept feedback after that date, so even if you miss it, I'll still listen to what you have to say and try to get it worked in.

The intention is that the documentation should be able to serve as a generic rule on how the decompiler works, and what you would have to do to add your own engine. It's not supposed to be a complete tutorial covering every line of code involved in adding an engine, but it should provide enough insight that you have a basic idea of what to do, and where to look for examples.

Even if all you do is look for style issues and misspellings, that's fine with me - all feedback is welcome.

Michael