First small part of the forthcoming documentation is available in the wiki, Any comments, corrections, ideas etc are welcome.
First small part of the forthcoming documentation is available in the wiki, Any comments, corrections, ideas etc are welcome.
Please fill in the wiki. The structure outlined is pretty cool. Lack of good documentation has made me stay away from using your library a lot.
ReplyDeleteI strongly suggest once you get all documented consider publishing a book on OmniThreadLibrary at lulu.com (as Marco and Dr. Bob do).
I promise I would be among the first to buy it.
Great start! The outline is pretty comprehensive and the diagrams in the pages you have started so far are already helpful with regards to visualising how to use the threading framework.
ReplyDeleteThis documentation will definitely make adoption of the OTL much easier as well as further promote its use.
Looking forward to seeing more!
Hello,
ReplyDeleteCould you also make one that describes the "symbols" used in pictures, they might be standard, but still might be better to explain them, so there will be no misunderstanding...
@Gad D Lord, I'm seriously considering this. The "OTL Book" is written in word and every wiki topic starts its life as a ready-to-print text. (For example, that's how Async looks: http://17slon.com/blogs/gabr/images/async.png)
ReplyDelete@Tommi Prami, yes, good idea.
I would buy it too. If you're doing it as a ready-to-print anyway, might as well earn a few bob! A lot of people like having a physical book to refer to, me included. To be honest, I might even have printed out the wiki once it's done for this reason!
DeleteThis is a great start and is making me see what all the fuss is about :)
ReplyDeleteI'm most looking forward to the simple "Introduction to OmniThreadLibrary" section.
I use threads extensively, and want to know what you're actually making easier/faster for me, and how :)
I think once I know that I'll probably use your framework a great deal.
I already know that TOmniValue is much faster than TValue (http://www.thedelphigeek.com/2010/03/speed-comparison-variant-tvalue-and.html).
I have a large, threaded code base that uses TValue extensively in a cache where speed is obviously important, and I'm bumping up against the limits of TValue's retrieval speed. Sure, I can code in hash tables to get the speed back, but of course that eats memory.
Had I not had an extremely strict time frame to code it in, I would have used your framework for that reason alone. I might still if I have time to go back and tinker when the pressure's off! :)
All in all, I'm very excited about this documentation, because it means I can take the plunge and not worry about using precious development time on any simple issues I may have once I start using OmniThread :)
Keep up the fantastic work!
Thanks for the kind words!
ReplyDeleteAnd keep in mind that you can use TOmniValue in your project without having to use other parts of the OmniThreadLibrary.
Gabr, your library is on such level that in my opinion it is the right time to focus mainly on documentation and bugs. I guess you would triple your user base if you would have a good documentation. You could also create a FAQ from your forum and stackoverflow question.
ReplyDelete@Soul Intruder, that was also on my mind.
ReplyDeleteEverybody - if someone wants to step in and put together a FAQ, I'd be most grateful.