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

Re-Structure README #79

Open
hf-kklein opened this issue Nov 3, 2021 · 0 comments
Open

Re-Structure README #79

hf-kklein opened this issue Nov 3, 2021 · 0 comments

Comments

@hf-kklein
Copy link
Contributor

hf-kklein commented Nov 3, 2021

The current README is very detailed but also very long.
For new/API users it might be a bit too much/too overwhelming in the way it currently is.
I'd suggest to

  • remove the local setup section and only refer to our python_template_repository and the instructions there
  • Separate the Terminology into
    1. Terms that are important for devs and for API users (e.g. "ahb expression", "condition expression", parsing vs. evaluation, differnet kinds of compositions)
    2. Terms that are only import for (ahbicht) devs (e.g. "transformer", "grammar", "tree", branches, tokens, UnevalautedFC, EvaluatableFC, etc.)
  • also we should make the API calls to our azure function a bit more prominent
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

No branches or pull requests

1 participant