From 29cf3a317409a39b94e21a65f2ac5bafc9d307b0 Mon Sep 17 00:00:00 2001 From: Dominique Lasserre Date: Sat, 1 Feb 2025 20:46:00 +0100 Subject: [PATCH] README.md: Add some system requirements (#438) --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c4ef114..b6657f6 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,19 @@ Documentation can be found at [Akkudoktor-EOS](https://akkudoktor-eos.readthedoc See [CONTRIBUTING.md](CONTRIBUTING.md). +## System requirements + +- Python >= 3.10, < 3.13 +- Architecture: amd64, aarch64 (armv8) +- OS: Linux, Windows, macOS + +Note: For Python 3.13 some dependencies (e.g. [Pendulum](https://github.com/python-pendulum/Pendulum)) are not yet available on https://pypi.org and have to be manually compiled (a recent [Rust](https://www.rust-lang.org/tools/install) installation is required). + +Other architectures (e.g. armv6, armv7) are unsupported for now, because a multitude of dependencies are not available on https://piwheels.org and have to be built manually (a recent Rust installation and [GCC](https://gcc.gnu.org/) are required, Python 3.11 is recommended). + ## Installation -The project requires Python 3.10 or newer. Official docker images can be found at [akkudoktor/eos](https://hub.docker.com/r/akkudoktor/eos). +Docker images (amd64/aarch64) can be found at [akkudoktor/eos](https://hub.docker.com/r/akkudoktor/eos). Following sections describe how to locally start the EOS server on `http://localhost:8503`.