search

cleandart / tiles

React like library
BSD 3-Clause "New" or "Revised" License
19 stars 3 forks source link

Documentation #29

Open dhasenan opened 10 years ago

dhasenan commented 10 years ago

Tiles appears to have no documentation. I'm rather unsure how to use it and have to trawl through the source code to find out how. Even then, I'm never going to be certain that I'm doing it the right way and not bludgeoning my way into making it somehow partially work.

A brief example would be great.

dhasenan commented 10 years ago

Found the examples in test/selenium. A link to them from the main page would be quite helpful. Separate documentation would still be great.

jakuub commented 10 years ago

Some example is in the test/selenium, as you found, the API examples can by hardly uderstanded from other tests, but it is quied difficult.

We plan to create the documentation of the Tiles library, but there was no time, as it was a part of my diploma thesis, so the main writing efford was focused in there. It is more descriptional, and in some places not the perfect representation of current state (in some parts i is outdated, and in some parts it talks about in future features), but it can be used as a first look at the library.

It is at https://github.com/jakuub/Magister-Thesis-Tiles, the main file is "jakub_uhrik.pdf" and the part about tiles is chapter "Our solution".

I will try to write some beta documentation in a short time.

jakuub commented 10 years ago

I just wrote the simple doc-like article to the wiki. It is not so refined and perfect, but for the first introduction it is better than nothing.