Skip to content

Commit 6505b49

Browse files
chore: update syntax in readme
1 parent f646123 commit 6505b49

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ A template repository for python projects in Sevan DWT.
99
[UV](https://docs.astral.sh/uv/) is a Python package and project manager, which handles Python versions and virtual environments for you.
1010
To install uv, type the following in the PowerShell terminal:
1111

12-
```powershell
12+
```console
1313
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
1414
```
1515

1616
This will download and install uv to:
1717

18-
```powershell
18+
```console
1919
C:\Users\<your-username>\.local\bin
2020
```
2121

2222
You should receive a message that uv has been installed.
2323
To use uv from the terminal window, you need to add it to your system's PATH.
2424
Write the following in the PowerShell terminal:
2525

26-
```powershell
26+
```console
2727
$env:Path = "C:\Users\<your-username>\.local\bin;$env:Path"
2828
```
2929

3030
After installing uv, you can check that uv is available by running the `uv` command:
3131

32-
```powershell
32+
```console
3333
uv
3434
```
3535

@@ -41,14 +41,14 @@ You should see a help menu listing the available commands.
4141
To get access to the internal packages, you need to set up your credentials towards Repoforge.
4242
This is done by running the `setup_credentials.ps1` script from the terminal window:
4343

44-
```powershell
44+
```console
4545
.\setup_credentials.ps1
4646
```
4747

4848
You might be prompted to enter your Repoforge token. If that happens, request a token from EBG/SLF.
4949
Enter your token when prompted. The credentials should now be saved to:
5050

51-
```powershell
51+
```console
5252
C:\Users\<your-username>\_netrc
5353
```
5454

@@ -59,7 +59,7 @@ Your setup should now be complete.
5959

6060
To test your setup, you can try to run one of your scripts:
6161

62-
```powershell
62+
```console
6363
uv run .\src\main.py
6464
```
6565

@@ -69,15 +69,15 @@ uv run .\src\main.py
6969

7070
To add a new package, you can use the `uv add` command. For example, to add the `numpy` package, you can run:
7171

72-
```powershell
72+
```console
7373
uv add numpy
7474
```
7575

7676
### Running the tests
7777

7878
To run the tests for the projec:
7979

80-
```powershell
80+
```console
8181
uv run pytest
8282
```
8383

0 commit comments

Comments
 (0)