Examples about usage statements

[sanliturk]

(1)

There is no examples of usage statements . By using trial and error , I could find the following statements :

[s@localhost kgt]$ Installed/bin/kgt -l bnf -e dot < examples/postal.bnf > postal.dot
[s@localhost kgt]$ Installed/bin/kgt -l bnf -e dot < examples/expr.bnf > expr.dot
[s@localhost kgt]$ Installed/bin/kgt -l abnf -e dot < examples/utf8.abnf > utf8.dot

The above statements are produced viewable .dot files .

[s@localhost kgt]$ Installed/bin/kgt -l iso-ebnf -e dot < examples/json.iso-ebnf > json.dot
25:33: Syntax error

Additional usage examples may be useful .

(2)

In README

pmake

is not available in every OS .

There is "bmake" to distinguish between GNU make and BSD make .

Mentioning bmake in README may be useful .

[s@localhost kgt]$ uname -a
Linux localhost.localdomain 4.18.11-200.fc28.x86_64 #1 SMP Sun Sep 30 15:31:40 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux
Fedora 28

(3)

In main.c :

in xusage :

Addition/modification of the following lines may be useful :

printf("usage: kgt [-nu] [-l <language>] [ -e <language> ]   <  input_file_name  >   output_file_name   \n");

printf(" -n : prettify
printf(" -u : allow undefined
printf(" -l : input language ( see io[]= in main.c for valid input names enclosed within ""
printf(" They are : bnf , wsn , abnf , iso-ebnf , rbnf
printf(" -e : output language ( see io[]= in main.c for valid input names enclosed within ""
printf(" They are : bnf , wsn , iso-ebnf , rbnf , sid , dot , rrdot , rrdump , rrparcon , rrta , rrtext
printf(" If there is a NULL in a column , do not use that name for -l or -e
printf(" h or ? : help
printf("

Explanation for "prettify" and "allow undefined" may be useful .
Links about wsn , rbnf , sid , dot , rrdot , rrdump , rrparcon , rrta , rrtext in README may be useful .

[katef]

All very true! Thank you for the observations. Would you like to submit a PR?

[sanliturk]

On Tue, Oct 23, 2018 at 4:37 AM Katherine ***@***.***> wrote: All very true! Thank you for the observations. Would you like to submit a PR? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#5 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABNVK2RBTDigVxjfd8Mcoa9qLskPQUQIks5unnLFgaJpZM4XaZnu> .

I could not understand how I can submit a different PR . I think , you may directly modify your repository files to incorporate my suggestions with respect to your style and decisions . M. E. Sanliturk

[katef]

Hiya,

I meant you're most welcome to make changes to the code yourself, if you want to :)

I converted the README to markdown, and added a bit of guidance: https://github.com/katef/kgt/blob/master/README.md
(You can see bmake is mentioned there, too. I know the make situation is confusing.)

I don't think this is a replacement for proper documentation. Rather than stuffing that sort of thing into xuage(), I'd prefer to have manpages for the CLI tool and API. Those will take some time to write properly, though.

I'd also like to provide an informal overview of the phases during compilation, rather like for libfsm here:
https://github.com/katef/libfsm/blob/master/doc/tutorial/phases.md

[sanliturk]

On Tue, Oct 23, 2018 at 4:45 PM Katherine ***@***.***> wrote: Hiya, I meant you're most welcome to make changes to the code yourself, if you want to :) I converted the README to markdown, and added a bit of guidance: https://github.com/katef/kgt/blob/master/README.md (You can see bmake is mentioned there, too. I know the make situation is confusing.) I don't think this is a replacement for proper documentation. Rather than stuffing that sort of thing into xuage(), I'd prefer to have manpages for the CLI tool and API. Those will take some time to write properly, though. I'd also like to provide an informal overview of the phases during compilation, rather like for libfsm here: https://github.com/katef/libfsm/blob/master/doc/tutorial/phases.md — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#5 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABNVK3m3thlOvEmTioaB4LYEM4L6AQC_ks5unx14gaJpZM4XaZnu> .

Thank you very much for your invitation to participate . I do not know anything about GIT usage , and I am not very fluent in C or C++ ( which you may be consider me "fully ignorant" ) . I need to study to use GIT , but , I think , it will be much later , because , at present I do not have ready sources to publish . Your decisions about improvement of your repository is very good . My suggestion to include some parts was only to be a concise guide to your users . In software area , the initial penetration into a software project usage is really very difficult if there is no explanations for the first time users to gain an understanding and continue to work/use of the software project . This first entry guidance is the most neglected part of the software projects . Your repository is a beautiful one . I wanted to fulfil your suggestion about sending suggestions to you . One of my goals is to write a C compiler with a very different approach to compilation of projects . Nearly all of the compilers are using ( lex - yacc ) pairs which generates a transition table parser , etc. It is very difficult to modify these compilers . In Pascal compilers , mostly rail road diagrams are used which they are relatively easy to understand and modify . My aim to write a C compiler directly by using its *BNF description to rail road diagrams to compiler and its interpreter . M. E. Sanliturk

[katef]

I added a manpage - https://github.com/katef/kgt/blob/master/man/kgt.1/kgt.1.xml
That's docbook source - rendering will come later.

Eventually I expect I'll write a proper user guide, but I'm not ready for that yet.

I'm going to close out this ticket; I expect general quality for everything to gradual improve in all areas. There's still a lot of things I think need attention.

Meanwhile thank you for your thoughts, I very much appreciate the ideas!

Happy new year :)

[sanliturk]

Also a happy new year and incoming years to you and all of the humanity . Thank you very much for your improvements . M . E. Sanliturk

…

On Tue, Jan 1, 2019 at 7:11 PM Katherine ***@***.***> wrote: I added a manpage - https://github.com/katef/kgt/blob/master/man/kgt.1/kgt.1.xml That's docbook source - rendering will come later. Eventually I expect I'll write a proper user guide, but I'm not ready for that yet. I'm going to close out this ticket; I expect general quality for everything to gradual improve in all areas. There's still a lot of things I think need attention. Meanwhile thank you for your thoughts, I very much appreciate the ideas! Happy new year :) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#5 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABNVK54uul5rEQ98fjtWqlb_c8WjjJlNks5u-4iggaJpZM4XaZnu> .