Where can I find documentation of the features available in the Ruby Shoe GUI toolkit?

Question

Is there any documentation that describes all the available functions and objects in shoes?

update: 2008.01.21 I am looking for a list of all the methods that can be called against an animated object.

For example, I just figured out how to pause the animation using the toggle () method by reading the source code from the shoebox ( http://the-shoebox.org/ ).

Answer 1

If you run

shoes -m 

in the console window (command line), the shoes will work in help mode / in manual mode.

In this mode, it displays a training manual, complete with runable examples (the manual is a shoe app). This mode has a built-in search function that jumps directly to the corresponding section of the documents and is very convenient for reference.

Most of this information is reformatted as html on the help.shoooes.net site mentioned above.

Since most open source projects go well documented. And, it seems, in fact, he showed restraint in the documentation (he obviously developed his ingenious madness in the fact that no one knows the instruction for training!).

Answer 2

Shoes Help seems to have all kinds of background documentation.

Answer 3

I have never seen such a thing for Shoes. It seems why she prefers to document her stuff with cartoons and collages.

Have you read Nobody knows the shoes ?

Answer 4

Animated objects inherit from TimerBase (like all Timer objects and objects), and as such have methods for drawing, deleting, starting, stopping, and switching. I don’t know too much ... this is from my notes, which I took while digging through a source of shoes. But that would be nice to start with.

Answer 5

It seems that there is no real documentation as such - you just have to use it from the examples [?] The rdoc attempt failed very well [just ran rdoc from the github repository] http://roger.doachristianturndaily.info/ruby/shoes/doc / you can look at the C code to try to find them :)