Skip to content

Commit 2a63590

Browse files
adam2392stefanv
andauthored
[DOC] Add install to readme (#142)
* Add install to readme Signed-off-by: Adam Li <adam2392@gmail.com> * Clarify meson/build/pip command distinction --------- Signed-off-by: Adam Li <adam2392@gmail.com> Co-authored-by: Stefan van der Walt <stefanv@berkeley.edu>
1 parent 018db2e commit 2a63590

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,31 @@ Available as `spin.cmds.meson.*`.
9292
docs 📖 Build Sphinx documentation
9393
gdb 👾 Execute a Python snippet with GDB
9494
lldb 👾 Execute a Python snippet with LLDB
95+
install 💽 Build and install package using pip.
9596
```
9697

9798
### [Build](https://pypa-build.readthedocs.io/en/stable/) (PEP 517 builder)
9899

99-
`spin` was started with Meson in mind, but we're working on expanding commands for PEP 517 `build`.
100+
Available as `spin.cmds.build.*`:
100101

101102
```
102103
sdist 📦 Build a source distribution in `dist/`
103104
```
104105

106+
### [pip](https://pip.pypa.io) (Package Installer for Python)
107+
108+
`pip` allows for editable installs, another common
109+
development workflow.
110+
111+
Note that, for now, the meson commands above do not work with an
112+
editable install of the package. We're [working on changing that](https://github.com/scientific-python/spin/pull/141).
113+
114+
Available as `spin.cmds.pip.*`:
115+
116+
```
117+
install 💽 Build and install package using pip.
118+
```
119+
105120
## 🧪 Custom commands
106121

107122
`spin` can invoke custom commands. These commands define their own arguments, and have access to the `pyproject.toml` file for further configuration.

0 commit comments

Comments
 (0)