From 01c13ca243050575e1c5eec4dc83f4d8215914d5 Mon Sep 17 00:00:00 2001 From: black-sliver <59490463+black-sliver@users.noreply.github.com> Date: Tue, 21 Mar 2023 09:36:25 +0100 Subject: [PATCH] Docs: some clarification in running from source --- docs/running from source.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/running from source.md b/docs/running from source.md index 2bda62ec..cb1a8fa5 100644 --- a/docs/running from source.md +++ b/docs/running from source.md @@ -7,10 +7,11 @@ use that version. These steps are for developers or platforms without compiled r ## General What you'll need: - * Python 3.8.7 or newer - * pip (Depending on platform may come included) - * A C compiler - * possibly optional, read OS-specific sections + * [Python 3.8.7 or newer](https://www.python.org/downloads/), not the Windows Store version + * **Python 3.11 does not work currently** + * pip: included in downloads from python.org, separate in many Linux distributions + * Matching C compiler + * possibly optional, read operating system specific sections Then run any of the starting point scripts, like Generate.py, and the included ModuleUpdater should prompt to install or update the required modules and after pressing enter proceed to install everything automatically. @@ -29,6 +30,8 @@ After this, you should be able to run the programs. Recommended steps * Download and install a "Windows installer (64-bit)" from the [Python download page](https://www.python.org/downloads) + * **Python 3.11 does not work currently** + * Download and install full Visual Studio from [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/) or an older "Build Tools for Visual Studio" from @@ -40,6 +43,8 @@ Recommended steps * It is recommended to use [PyCharm IDE](https://www.jetbrains.com/pycharm/) * Run Generate.py which will prompt installation of missing modules, press enter to confirm + * In PyCharm: right-click Generate.py and select `Run 'Generate'` + * Without PyCharm: open a command prompt in the source folder and type `py Generate.py` ## macOS @@ -59,7 +64,7 @@ setting in host.yaml at your Enemizer executable. ## Optional: SNI -SNI is required to use SNIClient. If not integrated into the project, it has to be started manually. +[SNI](https://github.com/alttpo/sni/blob/main/README.md) is required to use SNIClient. If not integrated into the project, it has to be started manually. You can get the latest SNI release at [SNI Github releases](https://github.com/alttpo/sni/releases). It should be dropped as "SNI" into the root folder of the project. Alternatively, you can point the sni setting in