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

Update Installation.md

Browse source 
There were broken links in the code block (```) sections because links aren't processed there.
This commit is contained in:
homeofpoe 2023-12-26 12:40:19 -08:00 • committed by GitHub
parent 7a7416b084
commit 7b133e4dbf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/Setup/Installation.md
View file

@ -1,12 +1,14 @@
# Installation
```{important}
If you are converting an existing game from a previous Evennia version, [see here](./Installation-Upgrade.md).
If you are converting an existing game from a previous Evennia version, you will need to upgrade.
```
The fastest way to install Evennia is to use the `pip` installer that comes with Python (read on).
You can also [clone Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md). Some users have also experimented with [installing Evennia on Android](./Installation-Android.md).
If you are converting an existing game, please follow the [upgrade instructions](./Installation-Upgrade.md).
## Requirements
```{sidebar} Develop in isolation
@ -20,9 +22,11 @@ Installing Evennia doesn't make anything visible online. Apart from installation
## Install with `pip`
```{important}
You are recommended to [setup a light-weight Python virtualenv](./Installation-Git.md#virtualenv) to install Evennia in. Using a virtualenv is standard practice in Python and allows you to install what you want in isolation from other programs. The virtualenv system is a part of Python and will make your life easier!
You are recommended to setup a light-weight Python virtualenv to install Evennia in. Using a virtualenv is standard practice in Python and allows you to install what you want in isolation from other programs. The virtualenv system is a part of Python and will make your life easier!
```
You re recommended to [setup a light-weight Python virtualenv](./Installation-Git.md#virtualenv) first.
Evennia is managed from the terminal (console/Command Prompt on Windows). Once you have Python installed—and after activating your virtualenv if you are using one—install Evennia with:
pip install evennia