Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Getting Started text #111

Merged
merged 3 commits into from
Nov 14, 2024
Merged

Update Getting Started text #111

merged 3 commits into from
Nov 14, 2024

Conversation

llewelld
Copy link
Contributor

Makes some small changes to the Getting Started guide:

  1. Adds some text to explain how to execute if you're using a project.
  2. Aligns the grammar structure variable throughout the code.
  3. Outputs the generated Julia code.

In the Getting Started guide the way to execute will depend on whether
the Herb.jl pakcages were installed globally or as part of a project.
This commit adds some text to highlight this distinction.
One of the variables used in the Getting Started section uses both g and
g₁ for the same grammar structure. This change switches them all to use
g.
The example in the Getting Started guide outputs the syntax tree and the
final output, but not the generated Julia code. This code is quite
instructive, so this change outputs the generated code as well.
@llewelld
Copy link
Contributor Author

@pwochner, here are the things we were discussing. Thanks for your help with this!

Copy link
Member

@ReubenJ ReubenJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@ReubenJ ReubenJ merged commit 5fb8256 into Herb-AI:master Nov 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants