Update of the user guide

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

Update of the user guide

gouessej
Administrator
Hi

I'm going to update the user guide. Some links are obsolete and some things have changed in JOGL 2.0. I plan to add several sections. I will use my fork on GIT to publish my changes.
Julien Gouesse | Personal blog | Website
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

gouessej
Administrator
Hi

My pull requests containing lots of changes is here:
https://github.com/sgothel/jogl/pull/48

Please read it carefully. I have just added a lot of sections and clarified some aspects.

English is not my mother tongue, feel free to fix my spelling mistakes. Best regards.
Julien Gouesse | Personal blog | Website
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

gouessej
Administrator
I will make another pull request later to clarify the following aspects:
- NEWT
- applet deployment (a link to a documented example)
- third party libraries for JOGL (a link to a dedicated page of the wiki)

@Sven, you should add something about Android deployment into the user guide.
Julien Gouesse | Personal blog | Website
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

Sven Gothel
Administrator
On 03/20/2012 03:02 PM, gouessej [via jogamp] wrote:
>
>
> I will make another pull request later to clarify the following aspects:
> - NEWT
> - applet deployment (a link to a documented example)
> - third party libraries for JOGL (a link to a dedicated page of the wiki)
>
> @Sven, you should add something about Android deployment into the user
> guide.

great stuff .. me currently adding a few things as well.
  - adding html anchors
  - proper TOC
  - native lib loading ..

hope git and html merge works well then :)

~Sven


signature.asc (910 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

gouessej
Administrator
I should have added some internal links so that other pages can point to a particular section if necessary.

I spoke about native lib loading but maybe I wasn't accurate enough. For example, I didn't explain that JARs containing native libraries don't need to be in the classpath.

I don't feel comfortable with Android.

I mentionned one of my tricks for SWT but I forgot to mention that it is the only way to allow the use of trace and debug pipelines without getting a GLException very early when using the SWT/AWT bridge.
Julien Gouesse | Personal blog | Website
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

Sven Gothel
Administrator
On 03/20/2012 04:16 PM, gouessej [via jogamp] wrote:
> I should have added some internal links so that other pages can point to a
> particular section if necessary.

I started it ..

>
> I spoke about native lib loading but maybe I wasn't accurate enough. For
> example, I didn't explain that JARs containing native libraries don't need
> to be in the classpath.

revised a few things about deployment etc ..

>
> I don't feel comfortable with Android.

me neither, who does ? - but it doesn't help - just kidding :)

will do.

>
> I mentionned one of my tricks for SWT but I forgot to mention that it is the
> only way to allow the use of trace and debug pipelines without getting a
> GLException very early when using the SWT/AWT bridge.

hmm.

+++

Ok .. me just pushed an update:

http://jogamp.org/git/?p=jogl.git;a=commit;h=6b8c90ea679f93924b105932c40590c01c5dc4fd

Pls test your edits w/ http://validator.w3.org/check,
the page is now clean.

Hope it's ok .., surely it's not done yet.

In the end it's not replacing the wiki,
but gives a static 'getting started' set of information.

Maybe you like to work on our wiki as well ?
You know you are very welcome.

~Sven


signature.asc (910 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Update of the user guide

gouessej
Administrator
Nice update, thanks. Of course, the user guide does not replace the wiki, that's why I tried to put links to some existing articles instead of rewriting the same things and I will do so for the third party APIs. I plan to work on the wiki too. A separate article about porting JOGL 1 programs to JOGL 2 would be useful.
Julien Gouesse | Personal blog | Website