Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make virtualenv text a little clearer

Browse source
This commit is contained in:
Griatch 2022-12-01 18:23:09 +01:00
parent 1c52489661
commit bb3112d2f4
2 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/Setup/Installation-Git.md
View file

@ -37,7 +37,11 @@ not recognize `localhost`).
## Virtualenv
A Python [virtual environment](https://docs.python.org/3/library/venv.html) allows you to install Evennia in its own little folder, separate from the rest of the system. You also won't need any extra permissions. It's optional to use a virtualenv, but it's highly recommended. Python supports this natively:
A Python [virtual environment](https://docs.python.org/3/library/venv.html) allows you to install Evennia and all its dependenceis in its own little isolated folder, separate from the rest of the system. This also means you can install without any extra permissions - it all goes into a folder on your drive.
It's optional to use a virtualenv, but it's highly recommended. Not only is this common Python praxis, it will make your life easier and avoid clashes with other Python programs you may have.
Python supports virtualenv natively:
```{sidebar} Using py on Windows
If you have older versions of Python installed on Windows, you should instead use `py` here instead of `python`. The `py` launcher automatically selects the latest python version among those you installed.
@ -52,12 +56,14 @@ Activate it like this:
```
source evenv/bin/activate (Linux, Mac)
evenv\Scripts\activate (Windows Console)
.\evenv\scripts\activate (Windows PS Shell,
Git Bash etc)
```
The text `(evenv)` should appear next to your prompt to show that the virtual
environment is active. You _don't_ need to actually be in or near the `evenv` folder for
environment is enabled. You do _not_ need to actually be in or near the `evenv` folder for
the environment to be active.
```{important}

2
docs/source/Setup/Setup-Overview.md
View file

@ -5,7 +5,7 @@ This sums up all steps of maintaining your Evennia game from first installation
## Installation and running
```{toctree}
:maxdepth: 2
:maxdepth: 1
Installation
Installation-Git