diff --git a/README.md b/README.md index faa600db..8b615de7 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,8 @@ your option, any later version. For more information, see [LICENSE](https://gith ## 1) Contact - [issue tracker / source repository](https://github.com/OpenTTD/nml) -- IRC chat using #openttd on irc.oftc.net [more info about our irc channel](https://wiki.openttd.org/Irc) +- IRC chat using #openttd on irc.oftc.net [more info about our IRC channel](https://wiki.openttd.org/en/Development/IRC%20channel) +- The Official OpenTTD [Discord](https://discord.gg/openttd) ## 2) Dependencies @@ -35,12 +36,13 @@ your option, any later version. For more information, see [LICENSE](https://gith NML requires the following 3rd party packages to run: - `python` - Minimal version is 3.5. Python 2 is not supported. + Minimum version is 3.10*. Python 2 is not supported. + Python versions before 3.10 might still work, but for developing NML, Python version 3.10 or newer is recommended. - `python image library` - For install options see https://pillow.readthedocs.io/en/stable/installation.html - Minimal version is 3.4. Older versions are not supported. + For install options see [Pillow: Basic Installation](https://pillow.readthedocs.io/en/stable/installation/basic-installation.html) + Minimum version is 3.4. Older versions are not supported. - `ply` - Downloadable from http://www.dabeaz.com/ply/ + NML comes bundled with ply version 2022.10.27, located in the `ply` folder inside the `nml` folder. ### 2.2) Optional dependencies @@ -57,16 +59,26 @@ Running `make test` requires these code formatters and checkers. You don't need ## 3) Installation -The easiest way to install NML is by using pip: +The easiest way to install NML is by using pip or [uv](https://docs.astral.sh/uv/): ```bash -pip3 install nml +python3 -m pip install nml +``` +or +```bash +uv tool install nml ``` In order to install NML from a source checkout run: ```bash -python setup.py install +python3 -m pip install . +``` + +If you want to install it in editable mode, so that changes to the code are instantly applied without reinstalling NML, run: + +```bash +python3 -m pip install -e . ``` If you want to install the package manually copy 'nmlc' to any directory diff --git a/setup.py b/setup.py index 8e34925b..3f3d0d11 100755 --- a/setup.py +++ b/setup.py @@ -48,7 +48,7 @@ ], url="https://github.com/OpenTTD/nml", author="NML Development Team", - author_email="nml-team@openttdcoop.org", + author_email="info@openttd.org", entry_points={"console_scripts": ["nmlc = nml.main:run"]}, ext_modules=[Extension("nml_lz77", ["nml/_lz77.c"], optional=True)], python_requires=">=3.10",