search

ScatterHQ / machinist

A library for constructing finite state machines
Apache License 2.0
58 stars 12 forks source link

Add tutorial-style documentation for building a very basic state machine #13

Open glyph opened 10 years ago

glyph commented 10 years ago

The example doesn't import and as per #11 and #4 it isn't even correct.

There is no narrative documentation beyond the README, and while the blog posts generally explain the motivation for using state machines, they don't cover how to make good use of machinist very well.

exarkun commented 10 years ago

Thanks. This is an accurate description of the (unarguably lamentable) current state of affairs. However, I don't find that it usefully encapsulates a piece of work to be done on machinist.

Could you imagine that #3 and #4 are resolved already and describe what further documentation would be of use?

Thanks again.

glyph commented 10 years ago

I suppose I was filing this intentionally as a broader issue than the lack of one particular bit of documentation. If either #3 or #4 were addressed, then there would technically be some documentation, so this issue would thereby be solved, so the summary was not very good :-).

What I was actually hoping for when I filed this was actually a tutorial, some kind of overarching structure for the documentation; #3 sounds like just an example and #4 sounds reference material. I guess it depends what you had in mind?