[DOCS PRELAUNCH] First text box broken: torchchat --help does not work. # is not a comment in Apple macOS zSH

[mikekgfb]

On cut and past of first command box from readme

1 - # is not an allowable comment character on macOS apparently

2 - torchchat help

--help does not appear to work without a subcommand, so the python3 torchchat.py --help is erroneous

If you want a top level help maybe it needs to be python torchchat.py help? Not ideal but that's what subcommands beget us. I do remember we had that discussion.

zsh: command not found: #
usage: torchchat [-h]
                 {chat,browser,download,generate,eval,export,list,remove} ...

positional arguments:
  {chat,browser,download,generate,eval,export,list,remove}
                        The specific command to run
    chat                Chat interactively with a model
    browser             Chat interactively in a browser
    download            Download a model from Hugging Face or others
    generate            Generate responses from a model given a prompt
    eval                Evaluate a model given a prompt
    export              Export a model for AOT Inductor or ExecuTorch
    list                List supported models
    remove              Remove downloaded model artifacts

options:
  -h, --help            show this help message and exit

[mikekgfb]

Resolved.