Skip to content

Commit

Permalink
Update README and docs with installation and platform support. Small
Browse files Browse the repository at this point in the history
fixes in the docs.
  • Loading branch information
janosmurai committed Nov 5, 2024
1 parent 494a5da commit 30a74b7
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 30 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
19 changes: 12 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
42 changes: 23 additions & 19 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,40 @@ 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!


### <ins>Alternative installation</ins>

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.

### <ins>Enable autocompletion</ins>

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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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...

Expand Down

0 comments on commit 30a74b7

Please sign in to comment.