Add some short installation and usage instructions #107
Conversation
README.md
Outdated
| ### Usage | ||
|
|
||
| > [!TIP] | ||
| > Currently, installing `pyodide-build` is preferred to running it. |
There was a problem hiding this comment.
What does this mean? I usually don't have the question "should I install this or should I run it" because usually I have to install first in order to run?
There was a problem hiding this comment.
Ah, I meant to convey that users are better off installing pyodide-build (globally or in a virtual environment) rather than trying to use pipx or uvx (instructions for which are provided for completeness). I'll try to reword this sentence.
There was a problem hiding this comment.
I hope 3ec2ab2 conveys the meaning better!
README.md
Outdated
| > [!NOTE] | ||
| > If installing `pyodide-build` and its dependencies in virtual environments, we recommend | ||
| using ones that are managed by `venv` or `virtualenv` at the moment; see #58. |
There was a problem hiding this comment.
| > [!NOTE] | |
| > If installing `pyodide-build` and its dependencies in virtual environments, we recommend | |
| using ones that are managed by `venv` or `virtualenv` at the moment; see #58. | |
| > [!NOTE] | |
| > Currently `pyodide-build` does not work well in environments managed by uv, see #58. |
I think this is the only thing in this PR that is appropriate for a readme. I think this adds a lot of noise, people can use pipx or uvx or venv or install pyodide-build globally or use whatever tools as they prefer. The readme isn't a tutorial on Python installer workflows.
There was a problem hiding this comment.
Makes sense to me, thanks!
Co-authored-by: Hood Chatham <[email protected]>
|
One reason we could keep the global installation instructions is that they are used quite often in CI environments; Considering that I can remove the unneeded bits, though. WDYT? |
2 participants
Description
This PR adds usage and installation instructions with
pip, global installation and usage instructions withpipxanduvx, and some general recommendations.This is mainly because I have these saved in my notes, which I have trouble finding at times – and the README could serve as a more permanent place for them until we have the documentation up and hosted.
Related to #54 and #58