monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: some clarification in running from source

This commit is contained in:
black-sliver 2023-03-21 09:36:25 +01:00
parent c2a8b842de
commit 01c13ca243
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/running from source.md
View File

@ -7,10 +7,11 @@ use that version. These steps are for developers or platforms without compiled r
## General ## General
What you'll need: What you'll need:
* Python 3.8.7 or newer * [Python 3.8.7 or newer](https://www.python.org/downloads/), not the Windows Store version
* pip (Depending on platform may come included) * **Python 3.11 does not work currently**
* A C compiler * pip: included in downloads from python.org, separate in many Linux distributions
* possibly optional, read OS-specific sections * 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 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. 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 Recommended steps
* Download and install a "Windows installer (64-bit)" from the [Python download page](https://www.python.org/downloads) * 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 * Download and install full Visual Studio from
[Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/) [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/)
or an older "Build Tools for Visual Studio" from 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/) * 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 * 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 ## macOS
@ -59,7 +64,7 @@ setting in host.yaml at your Enemizer executable.
## Optional: SNI ## 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). 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 It should be dropped as "SNI" into the root folder of the project. Alternatively, you can point the sni setting in