diff --git a/README.md b/README.md
index 150220e..82f5bef 100644
--- a/README.md
+++ b/README.md
@@ -64,14 +64,16 @@ development-specific tools are isolated in containers.
## Prerequisites
+Linux and Windows are supported.
+
+:information_source: macOS is not yet officially supported. However, if all prerequisites are met,
+DEM should work on macOS as well.
+
DEM depends on Python and Docker. Ensure you have the following versions:
- Python 3.10+
- Docker Engine 24.0+
-:information_source: macOS is not yet officially supported. However, if all prerequisites are met,
-DEM should work on macOS as well.
-
## Installation
First, install Python and Docker if you haven't already:
diff --git a/docs/index.md b/docs/index.md
index 1978374..69bd184 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -64,22 +64,27 @@ By adopting DEM's methodologies for environment setup and management, you can si
!!! linux_support "DEM for Linux"
Linux operating system is fully supported.
- Check out the [Installation](https://www.axemsolutions.io/dem_doc/latest/installation/) section and feel free to ask any questions
- in our community through [Discord](https://discord.gg/3aHuJBNvrJ).
+ Check out the [Installation](https://www.axemsolutions.io/dem_doc/latest/installation/) section
+ and feel free to ask any questions in our community through
+ [Discord](https://discord.gg/3aHuJBNvrJ).
!!! windows_support "DEM for Windows"
- DEM can be used in Windows Subsystem for Linux (WSL).
-
- Native Windows support is coming soon...
+ DEM can be used both natively on Windows and in Windows Subsystem for Linux (WSL).
- Feel free to join our open-source community and test DEM on different OSs. Please report your findings on [GitHub](https://github.com/axem-solutions/dem/issues) or in our community through [Discord](https://discord.gg/3aHuJBNvrJ).
+ Check out the [Installation](https://www.axemsolutions.io/dem_doc/latest/installation/) section
+ and feel free to ask any questions in our community through
+ [Discord](https://discord.gg/3aHuJBNvrJ).
!!! apple_support "DEM for Mac"
Coming soon...
- Feel free to join our open-source community and test DEM on different OSs. Please report your findings on [GitHub](https://github.com/axem-solutions/dem/issues) or in our community through [Discord](https://discord.gg/3aHuJBNvrJ).
+ macOS is not yet officially supported. However, if all prerequisites are met, DEM should work on
+ macOS as well.
+ Feel free to join our open-source community and test DEM on macOS. Please report your findings
+ on [GitHub](https://github.com/axem-solutions/dem/issues) or in our community through
+ [Discord](https://discord.gg/3aHuJBNvrJ).
!!! info "Container engines"
diff --git a/docs/installation.md b/docs/installation.md
index 46ef693..6f7bdf9 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -8,29 +8,19 @@ To use DEM on your PC, you need to have the following tools installed:
## **Installation**
+First, install Python and Docker if you haven't already:
-You can download the installer script from the root of the repository:
+- [Python](https://www.python.org/downloads/)
+- [Docker](https://docs.docker.com/get-docker/)
- curl -O https://raw.githubusercontent.com/axem-solutions/dem/main/install-dem.sh
+Make sure to include **pip** during Python installation.
-If you are happy with the content of the script, you can execute it:
-
- bash install-dem.sh
-
-!!! example "Example Tutorial"
-
- Learn by doing! Try our [tutorial](https://www.axemsolutions.io/tutorial/index.html)
- with a simple embedded project!
-
-
-### Alternative installation
-
-If all the prerequisites are fulfilled, DEM can be installed from the
-[PyPI repository](https://pypi.org/project/axem-dem/):
+Install DEM from the PyPI repository using:
pip install axem-dem
-:information_source: The package name is axem-dem, but the command is `dem`.
+- The package name is 'axem-dem', but the command is `dem`.
+- Ensure the Docker daemon is running before using DEM.
### Enable autocompletion
@@ -38,10 +28,20 @@ After installation, you can enable the autocompletion for bash and zsh shells
dem --install-completion
-> If the command didn't work, supply your shell type as input parameter (bash or zsh)
+If the command doesn't work, specify your shell type as an input parameter (powershell, bash, or zsh).
+
> Note for zsh users: `compinit` must be called from your .zshrc.
-## **Optional: Use the source code (for DEM developers)**
+!!! example "Example Tutorial"
+
+ Learn by doing! Try our [tutorial](https://www.axemsolutions.io/tutorial/index.html)
+ with a simple embedded project!
+
+## **Alternative method: run DEM from source**
+
+To run the DEM from source, you need to clone the repository first
+
+ git clone https://github.com/axem-solutions/dem
DEM can be run as a Python module. To do this, you need to add the `-m` flag to your command.
@@ -52,6 +52,10 @@ For example:
We use [poetry](https://python-poetry.org/) to manage dependencies. To ensure that you use the
correct versions of the required modules, you should enter the preconfigured virtual environment.
+If you don't have poetry installed, you can install it with:
+
+ pip install poetry
+
First install the environment with required dependencies:
poetry install
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 8144f8d..d9d20bd 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -30,7 +30,7 @@ In this case you only need to initialize the Dev Env with:
You can import a Dev Env descriptor JSON with:
- dem load DEV_ENV_NAME
+ dem import DEV_ENV_NAME
## I'd like to create my own Dev Env from scratch...