Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ stubs/*
dist/*
endstone/_version.py
conan_provider.cmake

# Python virtual environment
.venv/**
.venv
18 changes: 12 additions & 6 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,31 @@ just delete and recreate the environment. It's trivial to set up:
- Create a new virtual environment with:

```
python3 -m venv venv
python3 -m venv .venv
```

- Activate the environment with:

=== ":fontawesome-brands-windows: Windows"
=== ":fontawesome-brands-windows: Command Prompt"

``` sh
. venv/Scripts/activate
``` cmd
. .venv\Scripts\activate.bat
```

=== ":fontawesome-brands-windows: PowerShell"

``` powershell
. .venv\Scripts\Activate.ps1
```

=== ":fontawesome-brands-linux: Linux"

``` sh
. venv/bin/activate
. .venv/bin/activate
```


Your terminal should now print `(venv)` before the prompt, which is how you
Your terminal should now print `(.venv)` before the prompt, which is how you
know that you are inside the virtual environment that you just created.

- Exit the environment with:
Expand Down
18 changes: 12 additions & 6 deletions docs/tutorials/install-your-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,28 @@ Before installing your first plugin, you will need to build it.

To do so, you will need the activate the [virtual environment]. Please make sure Endstone is also installed inside the environment.

=== ":fontawesome-brands-windows: Windows"
=== ":fontawesome-brands-windows: Command Prompt"

``` sh
. venv/Scripts/activate
``` cmd
. .venv\Scripts\activate.bat
```

=== ":fontawesome-brands-windows: PowerShell"

``` powershell
. .venv\Scripts\Activate.ps1
```

=== ":fontawesome-brands-linux: Linux"

``` sh
. venv/bin/activate
. .venv/bin/activate
```

You can now enter this “development mode” by performing an [editable installation] inside the virtual environment,
using pip’s `-e/--editable` flag, as shown below:

``` sh title="(venv)"
``` sh title="(.venv)"
pip install --editable .
```

Expand Down Expand Up @@ -86,4 +92,4 @@ Before installing your first plugin, you will need to build it.

[editable installation]: https://pip.pypa.io/en/latest/topics/local-project-installs/

[virtual environment]: ../../getting-started/installation/#environment
[virtual environment]: ../getting-started/installation.md#environment
Loading