swig icon indicating copy to clipboard operation
swig copied to clipboard

Documentation

Open obuchtala opened this issue 11 years ago • 2 comments

The documentation needs a rewrite. It should be similar to that of the other modules.

Plus specialities:

  • Installation/Configuration specifics for different platforms and targets
  • Developer Handbook (How to get into the module code)
  • Embedding tutorials (Node.js, Customized Webkit/JSC, Customized V8)

At least until we finish this milestone I would prefer to work with a Markdown file. We should discuss such in general with William.

obuchtala avatar Sep 03 '13 10:09 obuchtala

@whoozle, @lefticus Does one of you want to start with that?

obuchtala avatar Sep 03 '13 10:09 obuchtala

@oliver---- I am no native speaker and never used non-generic swig documentation (used swig for cpython/v8), because swig is fairly uniform across this(maybe all?) target languages. I could try «Embedding v8» and swig-v8-c++integration for example. Please point me to the place where I could start if you still want me to do something. :)

whoozle avatar Sep 03 '13 19:09 whoozle