search

ippa / jaws

Jaws - HTML5 canvas javascript 2D Game Framework
https://jawsjs.ippa.se
GNU Lesser General Public License v3.0
363 stars 75 forks source link

Documentation download #44

Closed ftvs closed 12 years ago

ftvs commented 12 years ago

Hi ippa. Nice engine, man. I like the fact that every method is documented. I was just wondering whether the documentation is available for download. There's a Ruby build script, I understand, but from what I can tell it's for development on your end. The speed of offline documentation is noticable and saves you bandwidth, too.

Thanks, and good luck with your next Ludum Dare!

ippa commented 12 years ago

I guess "wget --mirror http://jawsjs.com/docs/index.html" would work .. I don't have a special zip or so, maybe it makes sense having it in the repo?

ftvs commented 12 years ago

Yes, scraping them myself would work. I'm also speaking in general, though. More people would download the documentation if the download was provided.

I think you generate the docs from source file comments, am I correct? Maybe having the docs in the repo as well may not make sense, because there would be duplication, and you would have to remember to build the docs every time you change them. I suppose if your build process is automated it would be fine.

What I had in mind was a simple download hosted either on GitHub or your site that you could link to from your site and README.rdoc. But that carries the same problem of duplication...

Just wondering aloud. It's up to you, ippa. Thanks. Tell me if I can help.

PS I ended up using Free Download Manager's HTML spider on my Windows machine because I don't have wget.

ippa commented 12 years ago

http://jawsjs.com/docs/jaws-docs.zip (link also @ jawsjs.com in the right sidebar)

Fixed in https://github.com/ippa/jaws/commit/6343ed4fdbdf50d123d767f83bacec9ba8ad6915

ftvs commented 12 years ago

Nice! I sincerely hope that people find the documentation download useful. Game on!

ippa commented 12 years ago

... np, so when will we see a new github repo with the start of your game? :)

ftvs commented 12 years ago

Heh, working on it. I'm aiming for within this year. I know how to program but I'm basically a beginner to game development, so I'm feeling a bit overwhelmed. That's why I'm looking to libraries and games like yours, to see how it's done.