Skip to content

Commit 235b05b

Browse files
committed
DOC: document how to run tests
1 parent 325eb6b commit 235b05b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
11
# xsf
22
Special function implementations
3+
4+
## Tests
5+
6+
To run the tests:
7+
- [clone this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
8+
- `cd xsf`
9+
- [install Pixi](https://pixi.sh/latest/#installation)
10+
- `pixi run tests`
11+
12+
For subsequent test runs, you can skip re-cloning [`xsref`](https://github.com/scipy/xsref) with:
13+
14+
```shell
15+
pixi run --skip-deps tests
16+
```
17+
18+
You can trigger a rebuild inbetween test runs with:
19+
20+
```shell
21+
pixi run build-tests
22+
```
23+
24+
> [!NOTE]
25+
> This has currently only been tested on Linux.

0 commit comments

Comments
 (0)