From 7f08ebf9dd6c56ecddcbb91be7afe32b11b5bcbb Mon Sep 17 00:00:00 2001 From: Marcos Marado Date: Fri, 1 Oct 2021 16:26:16 +0100 Subject: [PATCH] Getting Started: more troubleshooting info Issues #2434 or #2070 show that the installation guide can be a little bit confusing regarding on which directory should the user be when trying to pip install. This commit adds an entry on the Troubleshooting section, in hopes of helping those who stumble with that process. --- docs/source/Getting-Started.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/Getting-Started.md b/docs/source/Getting-Started.md index ecc38aa7d0..d2b6d2c25c 100644 --- a/docs/source/Getting-Started.md +++ b/docs/source/Getting-Started.md @@ -486,6 +486,9 @@ you can run `evennia -l`, or (in the future) start the server with `evennia star - Under some not-updated Linux distributions you may run into errors with a too-old `setuptools` or missing `functools`. If so, update your environment with `pip install --upgrade pip wheel setuptools`. Then try `pip install -e evennia` again. +- If you get an `setup.py not found` error message while trying to `pip install`, make sure you are + in the right directory. You should be at the same level of the `evenv` directory, and the + `evennia` git repository. Note that there is an `evennia` directory inside of the repository too. - One user reported a rare issue on Ubuntu 16 is an install error on installing Twisted; `Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-build-vnIFTg/twisted/` with errors like `distutils.errors.DistutilsError: Could not find suitable distribution for @@ -536,4 +539,4 @@ determined by Evennia. If you installed Twisted in a non-standard location this you should update the line to the real location. - Some users have reported issues with Windows WSL and anti-virus software during Evennia development. Timeout errors and the inability to run `evennia connections` may be due to your anti- -virus software interfering. Try disabling or changing your anti-virus software settings. \ No newline at end of file +virus software interfering. Try disabling or changing your anti-virus software settings.