Add documentation for the language and the framework

[sansyrox]

Self explanatory

[shearichard]

Just wanted to encourage this. The https://github.com/sparckles/starfyre#sample-usage is good but I think a series of examples, starting from something really basic up to the level of https://github.com/sparckles/starfyre#sample-usage would be good. I would be happy to contribute but I don't feel like I know enough to do that.

Maybe a model for this could be the first three examples on https://legacy.reactjs.org/ ("A Simple Component", "A Stateful Component", "An Application") ? If there was something similar to that in the README that would be a good start.

This is not to suggest that "proper" documentation isn't a good idea but, for me at least, having some "stepping stone" examples makes me feel enabled to experiment with something new.

[sansyrox]

Hey @shearichard 👋

That's a great suggestion 😄 , especially this one

Maybe a model for this could be the first three examples on https://legacy.reactjs.org/ ("A Simple Component", "A Stateful Component", "An Application") ? If there was something similar to that in the README that would be a good start.

I am just waiting a bit as there will be a few changes in PyML( the language) and the internals of the framework. However, as soon as the spec of the language is finalized. I will start with a model used in the old react website.

I would estimate we should have the first version very soon 😄

[nmstoker]

This seems like it might be an interesting project.

I would recommend direct links from the README to live working examples - to encourage further investigation people need to see if it suits their purpose and it's not realistic to expect them to install the sample app just to take a look.

I see too that the link to usage included above is now broken.