Skip to content

Doc: Update outdated information and modernise installation info. #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LordAro merged 1 commit into from
Jan 5, 2026
Merged

Doc: Update outdated information and modernise installation info. #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
<sub><sup>Python versions before 3.10 might still work, but for developing NML, Python version 3.10 or newer is recommended.</sub></sup>
- `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)
<sub><sup>Minimum version is 3.4. Older versions are not supported.</sub></sup>
- `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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down