Skip to content

Commit 8ce7784

Browse files
committed
test for lab1 action
1 parent 90ddb57 commit 8ce7784

File tree

2 files changed

+95
-20
lines changed

2 files changed

+95
-20
lines changed

.github/workflows/Lab_01_CI.yml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
1-
name: Lab_01
1+
name: Cheking of compile Arduino sketch for AVR/AtMega and ESP8266
22

3-
on: [push, pull_request]
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
pull_request:
7+
branches: [ main, master ]
48

59
jobs:
610
test-matrix:
711
strategy:
812
matrix:
9-
arduino-platform: ["arduino:samd", "arduino:avr"]
13+
arduino-platform:
14+
- "arduino:avr"
15+
- "esp8266:esp8266"
1016
include:
1117
- arduino-platform: "arduino:avr"
12-
fqbn: "arduino:avr:unowifi"
18+
fqbn: "arduino:avr:mega"
19+
- arduino-platform: "esp8266:esp8266"
20+
fqbn: "esp8266:esp8266:generic"
1321

1422
runs-on: ubuntu-22.04
1523

1624
steps:
17-
- name: Checkout
25+
- name: Checkout code
1826
uses: actions/checkout@v4
1927

20-
- name: Setup Arduino CLI
21-
uses: arduino/setup-arduino-cli@v1
28+
- name: Set up Arduino CLI
29+
uses: arduino/setup-arduino-cli@v2
2230

2331
- name: Install platform
2432
run: |
2533
arduino-cli core update-index
2634
arduino-cli core install ${{ matrix.arduino-platform }}
2735
2836
- name: Compile Sketch
29-
run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./mc_labs/mc_lab_01/mc_lab_01.ino
37+
run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./mc_labs/mc_lab_01/*.ino

README.md

Lines changed: 79 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,84 @@
1-
Introduction to Embedded Systems: Using ANSI C and the Arduino Development Environment.
21

3-
Slack: https://app.slack.com/huddle/T277SDD26/C9P6S41DH
2+
# 🛠️ Мікроконтролери частина 1 (Інструкція для студентів)
43

5-
Proteus IoT lib:
6-
https://github.com/LPNU-IoT/proteus-wemosd1-lib
4+
## 📚 Про предмет
75

8-
Recomended material:
6+
**Мікроконтролери частина 1** — це курс, на якому студенти вивчають основи роботи з мікроконтролерами (MCU), їх переваги, особливості та подальші напрямки розвитку в Embedded Systems, System Engineering та інших сферах. Курс забезпечує базові знання для просування в галузі.
97

10-
https://www.jimfiore.org/Books.html
11-
https://docs.arduino.cc/
12-
https://www.arduino.cc/reference/en/
13-
https://docs.arduino.cc/hardware/mega-2560/
14-
https://arduino.github.io/arduino-cli/0.35/
8+
## 📁 Структура репозиторія
159

16-
Simulation example:
17-
https://wokwi.com/projects/391005481372432385
10+
Цей репозиторій має наступну структуру:
11+
├── `REPOSITORY_OF_COURSE`
12+
   ├── **.github/workflows** — папка з GitHub Actions, що автоматично перевіряє ваш код. 🚀
13+
   ├── **labs** — папка з лабораторними роботами, в якій містяться всі необхідні. 🔬
14+
   ├── **lectures** — папка з лекціями. 📘
15+
   └── **README.md** — дана інструкція. 📄
16+
17+
> **🚨 УВАГА!**
18+
> Папку `.github/workflows` категорично заборонено змінювати.
19+
> Будь-які зміни в цій папці можуть призвести до автоматичного зниження балу за лабораторну роботу. ⚠️
20+
21+
## 🛠️ Як працювати з репозиторієм
22+
23+
1. **Створення гілки**: Для виконання кожної нової лабораторної роботи створіть окрему гілку від основної гілки `main` або `master` за наступним принципом:
24+
```bash
25+
git clone ${this_repository}
26+
git branch --list
27+
>>> main (active branch)
28+
git checkout -b ${student_surname_name}/labX
29+
30+
`X` — номер лабораторної роботи.
31+
`student_surname_name` — Прізвища та ім'я студента
32+
```
33+
34+
35+
2. **Робота з лабораторними роботами**: Помістіть вашу лабораторну роботу в відповідну папку у вашій гілці, яка буде називатися `labX`, де `X` знову номер лабораторної.
36+
37+
3. **Пул-реквест**: Щоб відправити вашу лабораторну роботу на перевірку, створіть пул-реквест на основну гілку (`main` або `master`) та чекайте, поки GitHub Actions виконає перевірку. 🔄
38+
39+
## ✅ Критерії перевірки
40+
41+
Ваш код буде перевірятися за наступними критеріями:
42+
43+
1. **Компільованість**: Код має успішно компілюватися. 💻
44+
2. **Стиль коду**: Код має відповідати заданому стилю написання. ✍️
45+
3. **Чистота коду**: Код не має містити зайвого сміття, яке не використовується. 🧹
46+
47+
> Якщо під час перевірки буде виявлено помилки за цими критеріями, вам потрібно їх виправити і знову запушити зміни у вашу гілку. Лабораторні роботи, які не пройшли перевірку, не будуть прийняті до перевірки. ❌
48+
49+
## 📝 Додаткові зауваження
50+
51+
- Будь ласка, уважно дотримуйтеся всіх інструкцій і не змінюйте конфігурацію GitHub Actions.
52+
- Переконайтеся, що ви уважно прочитали всі інструкції в лабораторних роботах та дотримуєтеся їх.
53+
- Всі лабораторні роботи повинні бути виконані та подані в межах термінів, визначених у плані курсу. ⏳
54+
55+
## ❓ Часті питання (FAQ)
56+
57+
- **Що робити, якщо я отримав помилку у перевірці?**
58+
Виправте помилки відповідно до повідомлень в GitHub Actions і знову запуште зміни. 🔧
59+
60+
- **Як створити пул-реквест?**
61+
Ви можете знайти детальні інструкції у [документації GitHub](https://docs.github.com/en/pull-requests). 📚
62+
63+
- **Куди звертатися за допомогою?**
64+
Якщо у вас є питання або проблеми, звертайтеся до викладача або на форум курсу. 🗣️
65+
66+
### Бажаємо успіхів у навчанні! 🚀
67+
68+
69+
> Introduction to Embedded Systems: Using ANSI C and the Arduino Development Environment.
70+
>
71+
> Slack: https://app.slack.com/huddle/T277SDD26/C9P6S41DH
72+
>
73+
> Proteus IoT lib:
74+
> https://github.com/LPNU-IoT/proteus-wemosd1-lib
75+
>
76+
> **Recomended material:**
77+
> 1. https://www.jimfiore.org/Books.html
78+
> 2. https://docs.arduino.cc/
79+
> 3. https://www.arduino.cc/reference/en/
80+
> 4. https://docs.arduino.cc/hardware/mega-2560/
81+
> 5. https://arduino.github.io/arduino-cli/0.35/
82+
>
83+
> Simulation example:
84+
> https://wokwi.com/projects/391005481372432385

0 commit comments

Comments
 (0)