search

senchalabs / jQTouch

Create powerful mobile apps with just HTML, CSS, and Zepto.js (or jQuery).
http://www.jqtouch.com/
MIT License
2.79k stars 592 forks source link

Please add some documentation #505

Closed silkcom closed 10 years ago

silkcom commented 10 years ago

The documentation and demos really seem out of date, makes it nearly impossible to even get it working enough to see if it's worth using.

Orange06 commented 10 years ago

Have you managed to load it in site at least ? The documentation is really poor and example provided are...well.. almost useless. Not to be mistaken, it looks like this is an awesome solution for not using JQMobile, but if there would only be a few extra tutorials or at least example so one would have something to learn from.

The examples show how to implement the script in the site, but when downloading zip file, we get totally new files than shown in example (scss not css...). I've included first jqtouch.scss file, than jquery.js and than jqtouch-jquery2.js. Here's the result: TypeError: $.jQTouch is not a constructor

Any explanations on that ? Otherwise it looks very promising, I'm really looking forward to work with jQTouch.

thomasyip commented 10 years ago

Thank @silkcom and @Orange06 for the comments. I think the easiest way to try jQT out is to download the demo release file:

jqt-demo-v0.99.4rc9-0-g6cfca478d17f-2.tar at https://github.com/senchalabs/jQTouch/releases/tag/v0.99.4rc9

Since we adpoted scss and coffee script, we gain a lot of productivity improvements, but traded away the ability for a new user to try jQT just by checking out the git repo.

I understand the general frustration on getting started, that's why I start making the demo jar. I am still hopeful that we can find a middle ground that doesn't require checking in processed artifacts into the source repo.

thomasyip commented 10 years ago

I updated the REAME.md. Hope it helps.