search

shnewto / bnf

Parse BNF grammar definitions
MIT License
258 stars 22 forks source link

Step by step example #38

Closed sergeyklay closed 2 years ago

sergeyklay commented 6 years ago

Hello,

First of all wanted to say thank you for your hard work on this project.

What do you think about creating step by step example with using simple grammar? It seems to me this would help to see the usual work flow and may show general concepts better.

FYI: There is a template to make a good README.md https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

shnewto commented 6 years ago

@sergeyklay I think that's a great idea, and I believe it represents a valuable addition. It's a really clean template too, I'll plan on incorporating some of it's style. Thank you for raising the issue!

shnewto commented 6 years ago

FYI, I'm working on a feature addition related to #33 that I'd like to have incorporated in the next week or so. I'll plan on making this part of the changes to the documentation that issue will require.

shnewto commented 6 years ago

Hey @sergeyklay , just checking in to say I haven't forgotten about this! I'm unsure what the timeline for this issue looks like at the moment but I thought I'd poll you for a little more info. Maybe you could provide an example of what a simple example might illustrate?

Some initial thoughts were examples that could do the following:

Would any of these options illustrate what you're interested in? What else would be valuable in terms of step-by-step examples?

Thanks!

sergeyklay commented 6 years ago

Hello @snewt,

I'm from yacc/bison world. In fact, what you described above is very interesting and probably will be enough. I just wanted to show you a few links that were very useful for me:

shnewto commented 6 years ago

Ah @sergeyklay those are great examples, I'll definitely pull from them for reference. Thank you. I think you'll be interested in the feature I'm working on at the moment (associated with issue #33) that will parse an input using a predefined Grammar to generate an AST or something like it (if the input is valid according to that grammar and report errors otherwise). That will help us make the leap to something more useful in terms of a corollary to lex/flex and yacc/bison.

CrockAgile commented 2 years ago

do you think the README has caught up to this issue? or what is still missing?

shnewto commented 2 years ago

I agree @CrockAgile

CrockAgile commented 2 years ago

Okay! then I am gonna close, but happy to re-open if anything else is needed