Skip to content

Commit 3de2df3

Browse files
committed
Fix example commands in readme
1 parent 746e419 commit 3de2df3

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,31 @@ does not have any awareness of Mojo source or package structure, `pytest` is ext
1515

1616
1. Create your Mojo tests according to the manual: https://docs.modular.com/mojo/tools/testing .
1717

18-
2. Install `mojo`, `python`, `pytest` and `pytest-mojo` plugin using the [conda](https://docs.anaconda.com/miniconda/)
18+
2. Install Mojo, Python, `pytest` and this `pytest-mojo` plugin using the [conda](https://docs.anaconda.com/miniconda/)
1919
[environment.yml](environment.yml) file. This can alternatively be done with the [magic](https://docs.modular.com/magic/)
2020
package manager, but [conda](https://docs.anaconda.com/miniconda/) is easier for this use case.
2121

2222
```shell
2323
# use conda to install mojo, python, and the pytest-mojo plugin.
24-
$ conda env -n foo-project create -f environment.yml
24+
$ conda env create -n foo-project -f environment.yml
2525

2626
# verify environment
2727
$ conda activate foo-project
28+
2829
$ mojo --version
2930
mojo 24.5.0 (e8aacb95)
31+
3032
$ python --version
3133
Python 3.12.6
34+
3235
$ conda list pytest
3336
...
3437
pytest 8.3.3 pyhd8ed1ab_0 conda-forge
3538
pytest-mojo 24.5 pypi_0 pypi
3639
pytest-xdist 3.6.1 pyhd8ed1ab_0 conda-forge
3740
```
3841

39-
Summary: it is a requirement is to have a `python` and `mojo` sharing the same runtime and packages and
42+
Summary: it is a requirement is to have Python and Mojo sharing the same runtime and packages and
4043
[conda](https://docs.anaconda.com/miniconda/) is the easiest way to accomplish that.
4144

4245
3. See the example project for one possible filesystem layout:
@@ -110,9 +113,9 @@ example_tests
110113

111114
## Links
112115

113-
- If you experience slowness, see this [tip about using multiprocessing]( https://github.com/guidorice/mojo-pytest/wiki#2024-07-17-here-is-a-performance-tip)
114-
with pytest.
116+
- If you experience slowness, see this
117+
[tip about using multiprocessing]( https://github.com/guidorice/mojo-pytest/wiki#2024-07-17-here-is-a-performance-tip) with `pytest`.
115118
- Writing tests in Mojo: https://docs.modular.com/mojo/tools/testing
116-
- Non-Python tests in `pytest`: https://pytest.org/en/7.4.x/example/nonpython.html#non-python-tests
117-
- C test runner: https://pytest-c-testrunner.readthedocs.io/
118-
- Pytest docs: https://docs.pytest.org
119+
- Non-Python tests in `pytest`: https://pytest.org/en/latest/example/nonpython.html#non-python-tests
120+
- C test runner: https://pytest-c-testrunner.readthedocs.io
121+
- `pytest` docs: https://docs.pytest.org

0 commit comments

Comments
 (0)