doc(install): fast track installation (without clone)#15
doc(install): fast track installation (without clone)#15samber wants to merge 1 commit intohcompai:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s installation documentation to enable a faster “no clone” setup path, aiming to reduce time-to-first-run for new users.
Changes:
- Add a
pipx install git+...quick-start install path. - Add an example command to run
surfer-h-cliusing environment variables. - Minor README formatting cleanup (removal of extra blank lines).
Comments suppressed due to low confidence (1)
README.md:63
- The new Quick Start section is immediately followed by
### From sources, but that section starts withcp .env.example .envwithout first telling the reader to clone the repository / change into the repo directory. Adding an explicitgit clone ... && cd ...(and any needed dependency bootstrap likeuv sync) at the start of the "From sources" section would make the flow unambiguous.
### From sources
Next, copy the example env variables.
```bash
cp .env.example .env
</details>
---
💡 <a href="/hcompai/surfer-h-cli/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
| Next, install the project. | ||
|
|
||
| ```bash | ||
| pipx install git+https://github.com/hcompai/surfer-h-cli |
There was a problem hiding this comment.
The Quick Start installs via pipx, but the repo requires Python >=3.11 (see pyproject.toml) and pipx may default to an older system Python. Consider adding a short prereq note and/or showing pipx install --python python3.11 ... (and optionally pipx ensurepath) so the install works reliably.
| Next, install the project. | |
| ```bash | |
| pipx install git+https://github.com/hcompai/surfer-h-cli | |
| Prerequisite: make sure you have **Python 3.11 or newer** and `pipx` installed. | |
| Next, install the project. | |
| ```bash | |
| pipx install --python python3.11 git+https://github.com/hcompai/surfer-h-cli |
| Next, install the project. | ||
|
|
||
| ```bash | ||
| pipx install git+https://github.com/hcompai/surfer-h-cli |
There was a problem hiding this comment.
The install URL here points to https://github.com/hcompai/surfer-h-cli, but the package metadata in pyproject.toml advertises https://github.com/hcompai/open-surferh as the Repository/Homepage. This mismatch is likely to confuse users (or install the wrong code). Please align the README install command with the canonical repo URL used by the project metadata.
| pipx install git+https://github.com/hcompai/surfer-h-cli | |
| pipx install git+https://github.com/hcompai/open-surferh |
It took me 15min to understand how to start the project and fix its dependencies. I think it should take < 2min.
This PR adds 2 simple commands to install and run the project without cloning the repository.
I would suggest adding a Docker image as well.
Making the distribution easy will help you gain traction.
Requires #13 to be merged first