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

2
docs/basic_operations.md
View File

@@ -12,7 +12,7 @@
* **Edit Tags:** Open the tags editor window. From here, you can add, rename, or delete tags. The tags can be added to a signal from the [tags menu](#4-tags)
* **Open Database Folder:** Shows the folder of the currently loaded database in the explorer.
* **Preferences:** Open the program settings window.
* **Exit:** This will simply close the application.
* **Exit:** This will close the application.
### Signal
* **New:** Add a new signal to the database.

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)
---

18
docs/contribute.md
View File

@@ -1,37 +1,37 @@
# Contribute
Artemis is an open source project an every contribution, no matter how small, is valuable and greatly appreciated. Don't worry about getting everything perfect, we are happy to work with you on your contribution and help you along the way. This guide will help you get started by outlining various ways you can contribute.
Artemis is an open-source project, and every contribution, no matter how small, is valuable and greatly appreciated. Don't worry about getting everything perfect; we are happy to work with you on your contribution and help you along the way. This guide will help you get started by outlining various ways you can contribute.
<div class="grid cards" markdown>
- :material-bug: __Spot a bug?__
- :material-bug: __Spot a bug?__
---
Open an issue (or pull request) and let us know the problem you faced (or you're working on)
Please open an issue (or pull request) and let us know the problem you faced (or you're working on)
[:octicons-arrow-right-24: Open an Issue](https://github.com/AresValley/Artemis/issues)
- :material-source-fork: __Fork the repository__
- :material-source-fork: __Fork the repository__
---
Create your own copy of the codebase that you can modify and submit pull requests from.
Create a copy of the codebase from which you can modify and submit pull requests.
[:octicons-arrow-right-24: Fork the repo](https://github.com/AresValley/Artemis)
- :material-lightbulb-on: __Ideas?__
- :material-lightbulb-on: __Ideas?__
---
Idea for a new feature? Open an issue on the project's GitHub repository to describe your proposal in detail.
Idea for a new feature? Open an issue on the project's GitHub repository to describe your proposal.
[:octicons-arrow-right-24: Open an Issue](https://github.com/AresValley/Artemis/issues)
- :material-heart: __Spreading the word!__
- :material-heart: __Spreading the word!__
---
Do you like Artemis? Don't forgeto to share it with your network and your friends!
Do you like Artemis? Remember to share it with your network and your friends!
</div>