refactor: docs #4

Merged
weirdcat merged 1 commits from feat-windows_dockerfile into main 2025-12-16 19:24:07 +03:00
Showing only changes of commit 036a0e6d9a - Show all commits

View File

@@ -41,7 +41,7 @@
Вам потребуется поддерживаемая операционная система из списка ниже. Если галочки нет, то поддержка появится в будущем.
- [x] Linux (Wayland)
- [x] Linux (XORG)
- [ ] Windows 10/11 (не тестировалось, должно билдиться)
- [x] Windows 10/11
- [ ] MacOS (не тестировалось, должно билдиться)
### ⬇️ Установка
@@ -50,12 +50,23 @@
### ⚙️ Настройка
При первом запуске будет необходимо выполнить настройку приложения. В Linux файл конфигурации располагается здесь:
`~/.config/auto-attendance/auto-attendance.toml`. Необходимо получить актуальный файл конфигурации, который будет работать с конкретным журналом посещений
При первом запуске будет необходимо выполнить настройку приложения. Расположение файла конфигурации зависит от системы:
- В Linux:
- `~/.config/auto-attendance/auto-attendance.toml`
- В Windows:
- `C:\Users\user\AppData\Roaming\auto-attendance\auto-attendance.toml`
Необходимо получить актуальный файл конфигурации, который будет работать с конкретным журналом посещений. Ключевую роль играют следующие параметры:
```toml
qr_query_token = '' # Название query-параметра, содержащего уникальный токен ссылки
self_approve_url = '' # Полный URL ссылки QR-кода (без query-параметров)
```
## 🔨 Сборка
### 🧩 Зависимости
### Make (Linux, MacOS)
#### 🧩 Зависимости
- git
- make
@@ -63,24 +74,7 @@
- opencv 4.12.0
- go 1.25.4
### Go
Используйте следующую команду в терминале:
```bash
go install git.weirdcat.su/weirdcat/auto-attendance/cmd/qrminator-cli@main
```
Далее можно запускать командой:
```bash
qrminator-cli
```
Убедитесь, что вы добавили `~/.go/bin` в PATH. Например:
```bash
export PATH=$PATH:~/.go/bin
```
### Make
#### Порядок сборки
Склонируйте мой репозиторий:
```bash
@@ -99,10 +93,30 @@ make
# make build-linux
# make build-macos
# make build-windows
```
Далее для запуска можете использовать команду `make run`.
### Dockerfile (Windows)
На данный момент единственный проверенный и самый простой способ собрать приложение под Windows - использовать [специальный Dockerfile](https://git.weirdcat.su/weirdcat/auto-attendance/raw/branch/main/Dockerfile.windows-build). На Windows для этого можно использовать WSL с Docker.
#### Порядок сборки (Bash):
```bash
# Создаем директорию и переходим в нее
mkdir build && cd build
# Получаем содержимое Dockerfile
curl "https://git.weirdcat.su/weirdcat/auto-attendance/raw/branch/main/Dockerfile.windows-build" > Dockerfile
# Выполняем сборку
docker build -t autoattendance-build-windows .
# Копируем бинарник из образа в текущую папку
docker run --rm -v $(pwd):/output autoattendance-build-windows sh -c "cp /go/src/auto-attendance/bin/autoattendance.exe /output/"
```
Готовое приложение - файл `autoattendance.exe`.
# Поддержать разработчиков
![Николай (Telegram)](https://t.me/thebreadcat)