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

zti configuration needs documentation #36

Open
1000TurquoisePogs opened this issue Aug 26, 2022 · 1 comment
Open

zti configuration needs documentation #36

1000TurquoisePogs opened this issue Aug 26, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@1000TurquoisePogs
Copy link

1000TurquoisePogs commented Aug 26, 2022

I got zti running after an hour of searching the code and guessing. It'd be nice not to do that. It raised points such as

  • what is the syntax of .ztirc? (seems to be set some_property_here some_value_here)
  • some of zti is configured by things that can be specified in .ztirc, but others must be set as environment variables, despite all the values looking like they could be environment variables.

I was going to take a shot at submitting a PR but... python is its own barrier to entry. As much as I love the project idea and am starting to be a happy user I'd sooner rewrite it in a language with ordinary syntax than try and figure out what python is up to.

@najohnsn
Copy link
Member

The syntax of .ztirc is one zti command per line. On zti command line, enter help to see what those commands are.

@najohnsn najohnsn added the documentation Improvements or additions to documentation label Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants