@@ -29,30 +29,26 @@ git clone https://github.com/<your-username>/ragna.git
2929
3030### Set up development environment and run Ragna
3131
32- We use [ Pixi] ( https://pixi.sh/dev/ ) to manage development environments with Ragna.
33-
34- Ragna has three main development environments: ` dev-all-py310 ` , ` dev-all-py311 ` , and
35- ` dev-all-py312 ` , which use Python 3.10, 3.11, and 3.12, respectively. The environment
36- ` dev-all ` is the same as ` dev-all-py310 ` . The environment ` dev-all ` is used as an
37- example in the sections below, but you can use any of the three Python versions you
38- like.
32+ We use [ Pixi] ( https://pixi.sh/dev/ ) to manage development environments with Ragna. The
33+ main development environment is ` all-py310 ` , which should be used for most use cases and
34+ is used in the sections below.
3935
4036To install a development environment, run
4137
4238``` bash
43- pixi install -e dev- all --frozen
39+ pixi install --environment all-py310 --frozen
4440```
4541
4642You can then run Ragna with
4743
4844``` bash
49- pixi run -e dev- all ragna deploy
45+ pixi run --environment all-py310 ragna deploy
5046```
5147
5248You can verify that a development version of Ragna is correctly installed with
5349
5450``` bash
55- pixi run -e dev- all ragna --version
51+ pixi run --environment all-py310 ragna --version
5652# Ideal output: ragna <version-number> devXXXX from ...
5753```
5854
@@ -75,7 +71,7 @@ on each pull request.
7571You can run Ragna tests with
7672
7773``` bash
78- pixi run -e dev- all test
74+ pixi run --environment all-py310 test
7975```
8076
8177#### Formatting & Linting
@@ -84,21 +80,21 @@ To run the [Ruff code formatter and checker](https://docs.astral.sh/ruff/formatt
8480well as other useful formatting and linting tools, you can use
8581
8682``` bash
87- pixi run -e dev pre-commit
83+ pixi run --environment all-py310 pre-commit
8884```
8985
9086#### Type checking
9187
9288You can check type annotations with [ Mypy] ( https://mypy-lang.org/ ) using
9389
9490``` bash
95- pixi run -e dev- all types
91+ pixi run --environment all-py310 types
9692```
9793
9894or
9995
10096``` bash
101- pixi run -e dev- all mypy
97+ pixi run --environment all-py310 mypy
10298```
10399
104100#### All of the above
@@ -107,7 +103,7 @@ To run all the above checks using a single command as they would be run on the C
107103can use
108104
109105``` bash
110- pixi run -e dev- all ci
106+ pixi run ---environment all-py310 ci
111107```
112108
113109## Contribute documentation
@@ -127,13 +123,11 @@ To start a development build of the website that auto-refreshes on new changes,
127123following from the project root:
128124
129125``` bash
130- pixi run -e dev- all mkdocs serve
126+ pixi run --environment all-py310 mkdocs serve
131127```
132128
133129This serves the docs website at [ http://127.0.0.1:8000 ] ( http://127.0.0.1:8000 ) .
134130
135- You must use a ` dev-all* ` environment to build the docs.
136-
137131### View, add, or update images
138132
139133Ragna tracks most image files with [ ` git-lfs ` ] ( https://git-lfs.com ) .
0 commit comments