[Scummvm-devel] Readme stable? + Readme GUI button

[Eugene Sandulenko]

On 12 July 2011 20:21, Simon Sawatzki <SimSaw at gmx.de> wrote:
> I wondered if the Readme is stable as I consider translating a bigger part of it
This is a good idea.

> However, I read at some point in the past in the forums that a major rewrite of the Readme is planned or at least wished.
Actually the rewrite already took place. We moved README on Wiki in a
hope that more people will be working on it. Unfortunately that did
not work well, so perhaps it is a good time for calling out for
editors on our forums and website.

So probably it would be better to (a) update documentation on Wiki (b)
translate that (c) write simple dumper of Wiki pages into plain HTML
and extract that at release time.

I.e. currently there are two sources of documentation which adds
additional maintenance overhead. However, this should be a separate
topic for discussion, and should not prevent you from starting the
translation, as the content on both instances should match.

> Can someone comment on this? Would you recommend to translate the Readme now or is it not stable enough (will there be too many changes that will make updating very hard)?
README actually needs some updates. But that means extending the
content, not modifying existing one. The missing things are:
  o Virtual Keyboard
  o GUI translations
  o EGA undithering
  o GM device selector
  o Section on describing paths, i.e. extrapath vs gamepath vs themepath
  o GUI renderer
  o GMM (this is omitted althogeter)

Probably I will have time to describe some if there will be no help
from others, but somebody has to fix my broken English after that.

> However, I got an idea that might avoid the problem of the Readme being wrongly displayed. A "Display README..." button could be inserted (next to the "About" button maybe) and the README could be displayed inside ScummVM in an extra window like the credits, but with no automatic scrolling. Instead there should be a scrolling bar to the right like in the debugger.
No, our fonts are not the best, and reading 100kb of text is not a
good idea. We could, however think about developing a context help
subsystem, but that's a big project by itself. So far we covered part
of functionality with tooltips.

> To be consequent, we should also include the Readme file(s) that will be used inside ScummVM in the EXE for Windows then (like it is done with the rest of the GUI stuff now; of course we may still keep the text file in the programme's directory anyway). The advantage would be that nobody could change it easilly by hand in the EXE file and then give it with wrong/undesired information to others.
No, putting that into Windows executable is not a good idea.


Eugene