wouter/Artemis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Corrected few docs typo

Browse Source
This commit is contained in:
Marco Dalla Tiezza
2024-06-05 00:05:00 +02:00
parent 7929c23ac5
commit ab8403c16e
3 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/build_package.md
View File

@@ -1,5 +1,5 @@
# Build Package
Building a distributable package with an executable for Artemis creates a practical solution for end-users, as they can run the application without needing to interact with the terminal and they can easily share the application as a stand-alone package.
Building a distributable package with an executable for Artemis creates a practical solution for end-users, as they can run the application without needing to interact with the terminal and they can easily share the application as a standalone package.
## Requirements
* Python (3.11 or higher)
@@ -8,7 +8,7 @@ Building a distributable package with an executable for Artemis creates a practi
We assume that Python is already installed on the system and the Artemis source code has been downloaded and extracted. If these prerequisites are not met, please follow steps 1 to 3 in the [run from source section](run_from_source.md).
!!! warning "Cross-Compilation"
To generate standalone packages, an operating system that matches the target OS must be used, as Nuitka does not support cross-compilation. For example: you cannot build binaries on Windows that work on Linux or macOS.
An operating system that matches the target OS must be used to generate standalone packages, as Nuitka does not support cross-compilation. For example, you cannot build binaries on Windows that work on Linux or macOS.
## :simple-windows: Windows
@@ -20,7 +20,7 @@ Building a distributable package with an executable for Artemis creates a practi
.\building\Windows\build_windows.ps1
```
2. Wait for the build process to complete. This may take a few minutes depending on your system's performance. Once the process finishes, check the `artemis.dist/` directory: it will contain the stand-alone software with the `artemis.exe` executable.
2. Wait for the build process to complete. This may take a few minutes depending on your system's performance. Once the process finishes, check the `artemis.dist/` directory: it will contain the standalone software with the `artemis.exe` executable.
---
@@ -33,7 +33,7 @@ Building a distributable package with an executable for Artemis creates a practi
. ./building/Linux/build_linux.sh
```
2. Wait for the build process to complete. This may take a few minutes depending on your system's performance. Once the process finishes, check the `artemis.dist/` directory: it will contain the stand-alone software with the `app.bin` executable.
2. Wait for the build process to complete. This may take a few minutes depending on your system's performance. Once the process finishes, check the `artemis.dist/` directory: it will contain the standalone software with the `app.bin` executable.
3. If you wish to create a shortcut, follows the procedure in the [installation section](installation.md/#create-a-shortcut)
---