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

Add configuration instructions to readme #20

Open
natalie-robinson opened this issue Sep 13, 2023 · 0 comments
Open

Add configuration instructions to readme #20

natalie-robinson opened this issue Sep 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@natalie-robinson
Copy link

In the "How to use" section of the readme, the command to run is provided but there are no instructions for helping users configure their "knit" command (i.e., find the path to knit and set it in their environmental variables, zshrc, etc.). These instructions would be incredibly helpful.

Running on a Mac, I did the following (after installing TeXLive and pandoc and zen-knit):

  1. From terminal, "mdfind knit"
  2. Open .zshrc and add (based on the output of the above):
    "alias knit=/Users/myName/Library/Python/3.9/bin/knit"
@contactzen contactzen added the documentation Improvements or additions to documentation label Nov 24, 2023
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