search

dalekjs / dalek

[unmaintained] DalekJS Base framework
MIT License
695 stars 63 forks source link

dalekfile config documentation #105

Open cupito opened 10 years ago

cupito commented 10 years ago

Great work that tool, but i am still missing a extended documentation. For my example I installed different portable browser to test it. Now i tried to set up this in my dalekfile. It was mess to find out how to setup different versions of firefox and chrome. There are no hint to add the "actAs" option in the configuration. That's bad for such a good tool. Would be good to have all options somewhere together to speed up the work with dalekjs.

asciidisco commented 10 years ago

Please feel free to help out with this, Dalek is mostly a one man show, so it is really hard to enhance the docs while also trying to evolve the library & answer user questions (I know, the last part could be less time consuming with better docs).

cupito commented 10 years ago

As soon as I finished my software validation, I will take the chance to do this. Is there any preferred way to set up the documentation? test cases, html, tex?

asciidisco commented 10 years ago

WE use the code docs to generate HTML out of (hint you can use markdown in the comments). Tests would also be appreciated (we use mocha+chai). Thanks.