Skip to content

Commit 1977fae

Browse files
committed
Remove building on Mac and added installation instructions
1 parent 91dc184 commit 1977fae

File tree

2 files changed

+70
-40
lines changed

2 files changed

+70
-40
lines changed

.github/workflows/release_pipeline.yml

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,6 @@ on:
99
- master
1010

1111
jobs:
12-
build-macos:
13-
runs-on: macos-latest
14-
steps:
15-
- name: Checkout code
16-
uses: actions/checkout@v4
17-
18-
- name: Set up Python
19-
uses: actions/setup-python@v5
20-
with:
21-
python-version: '3.x'
22-
23-
- name: Install PyInstaller
24-
run: pip install pyinstaller pyserial tkmacosx
25-
26-
- name: Build with PyInstaller
27-
run: pyinstaller arduino_logique.spec
28-
29-
- name: Compress the build
30-
run: |
31-
cd dist
32-
tar -chzvf arduino_logique_macos.tar.gz arduino_logique
33-
34-
- name: Upload artifact
35-
uses: actions/upload-artifact@v3
36-
with:
37-
name: macos-build
38-
path: dist/arduino_logique_macos.tar.gz
39-
4012
build-ubuntu:
4113
runs-on: ubuntu-latest
4214
steps:
@@ -92,7 +64,7 @@ jobs:
9264
path: arduino_logique_windows.zip
9365

9466
release:
95-
needs: [build-macos, build-ubuntu, build-windows]
67+
needs: [build-ubuntu, build-windows]
9668
runs-on: ubuntu-latest
9769
permissions:
9870
contents: write
@@ -102,12 +74,6 @@ jobs:
10274
with:
10375
fetch-depth: 0
10476

105-
- name: Download macOS build
106-
uses: actions/download-artifact@v3
107-
with:
108-
name: macos-build
109-
path: ./dist/
110-
11177
- name: Download Ubuntu build
11278
uses: actions/download-artifact@v3
11379
with:
@@ -132,7 +98,7 @@ jobs:
13298
- name: Create release
13399
uses: ncipollo/release-action@v1
134100
with:
135-
artifacts: "./dist/arduino_logique_macos.tar.gz,./dist/arduino_logique_ubuntu.tar.gz,./dist/arduino_logique_windows.zip"
101+
artifacts: "./dist/arduino_logique_ubuntu.tar.gz,./dist/arduino_logique_windows.zip"
136102
token: ${{ secrets.GITHUB_TOKEN }}
137103
tag: ${{ steps.bump.outputs.new_tag }}
138104
makeLatest: ${{ !contains(steps.bump.outputs.new_tag, 'beta') }}

readme.md

Lines changed: 68 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,49 @@
1313
## Contents
1414

1515
- [Installation Instructions (English)](#installation-instructions)
16+
- [MacOS installation](#macos-installation)
1617
- [Windows installation](#windows-installation)
1718
- [Microcontroller](#microcontroller)
1819
- [Instructions d'installation (Français)](#instructions-dinstallation)
19-
- [Microcontrôleur](#microcontrôleur)
20+
- [Installation sur MacOS](#installation-sur-macos)
2021
- [Installation sur Windows](#installation-sur-windows)
22+
- [Microcontrôleur](#microcontrôleur)
2123

2224
## Installation Instructions
2325

2426
Please go to the [release page](https://github.com/Team-Arduino-Logique/Arduino-Logique/releases) and download the latest release for your operating system.
2527

28+
### MacOS installation
29+
30+
#### Prerequisites for macOS
31+
32+
1. Install Python 3.
33+
2. Install the required Python packages:
34+
- pyserial
35+
- tkmacosx
36+
37+
You can install the packages using pip:
38+
39+
```sh
40+
pip install pyserial tkmacosx
41+
```
42+
43+
To download the source code, you can clone the repository using git. Open a terminal and run the following command:
44+
45+
```sh
46+
git clone https://github.com/Team-Arduino-Logique/Arduino-Logique.git
47+
```
48+
49+
This will create a local copy of the repository on your machine.
50+
51+
#### Running `arduino_logique.py` on MacOS
52+
53+
After installing the prerequisites, you can run the `arduino_logique.py` script by navigating to the directory where the script is located and executing the following command in the terminal:
54+
55+
```sh
56+
python arduino_logique.py
57+
```
58+
2659
### Windows installation
2760

2861
Windows Defender will warn you about an unverified program. You can still execute it by clicking "More information", then "Continue".
@@ -35,12 +68,43 @@ Windows Defender will warn you about an unverified program. You can still execut
3568

3669
Veuillez vous rendre sur la [page des versions](https://github.com/Team-Arduino-Logique/Arduino-Logique/releases) et télécharger la dernière version pour votre système d'exploitation.
3770

38-
### Microcontrôleur
71+
### Installation sur MacOS
3972

40-
#### TODO instructions pour microcontrôleur
73+
#### Prérequis pour macOS
74+
75+
1. Installez Python 3.
76+
2. Installez les packages Python requis :
77+
- pyserial
78+
- tkmacosx
79+
80+
Vous pouvez installer les packages en utilisant pip :
81+
82+
```sh
83+
pip install pyserial tkmacosx
84+
```
85+
86+
Pour télécharger le code source, vous pouvez cloner le dépôt en utilisant git. Ouvrez un terminal et exécutez la commande suivante :
87+
88+
```sh
89+
git clone https://github.com/Team-Arduino-Logique/Arduino-Logique.git
90+
```
91+
92+
Cela créera une copie locale du dépôt sur votre machine.
93+
94+
#### Exécution de `arduino_logique.py` sur MacOS
95+
96+
Après avoir installé les prérequis, vous pouvez exécuter le script `arduino_logique.py` en naviguant vers le répertoire où le script est situé et en exécutant la commande suivante dans le terminal :
97+
98+
```sh
99+
python arduino_logique.py
100+
```
41101

42102
### Installation sur Windows
43103

44104
Lors de l'installation sur Windows, un avertissement de sécurité peut apparaître. Pour continuer, cliquez sur "Informations complémentaires", puis sélectionnez "Exécuter quand même".
45105

46-
![Avertissement de sécurité Windows](docs/images/defender-warning-french.png)
106+
![Avertissement de sécurité Windows](docs/images/defender-warning-french.png)
107+
108+
### Microcontrôleur
109+
110+
#### TODO instructions pour microcontrôleur

0 commit comments

Comments
 (0)