Files
031-flash-card/docs/wiki/Install-ms.md
T
Tirsvad 9c8e294021 MIL-010 plan and documents: release v0.1.0
Milestone MIL-010, story US-001.08, BC-001 and PP-001 amended (the release
of the executable is in scope), CHANGELOG.md for 0.1.0, and links to the
release page in README and the Install page of the wiki. Review records
RC-051 to RC-054, all Go (autonomous mode, not independent).

Task: MIL-010#1
Task: MIL-010#2
2026-10-15 08:37:38 +08:00

2.8 KiB

Pemasangan

🌐 English · Dansk · Bahasa Malaysia

Keperluan

  • Python 3.13 atau lebih baharu dengan Tkinter (pada Debian atau Ubuntu: sudo apt install python3-tk).
  • git.
  • Pilihan: sambungan internet dan tambahan speech jika anda mahu mendengar perkataan Melayu.

Dapatkan kod

git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/031-flash-card.git
cd 031-flash-card

Cipta dan gunakan persekitaran maya setempat

Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Linux dan macOS:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
  • .[dev] menambah pytest, ruff, mypy dan import-linter. Gunakan . jika anda hanya mahu menjalankan program.
  • Jika PowerShell enggan menjalankan Activate.ps1, jalankan Set-ExecutionPolicy -Scope CurrentUser RemoteSigned sekali.
  • Keluar daripada persekitaran dengan deactivate; padam folder .venv untuk bermula semula.

Perkataan Melayu bersuara (pilihan)

python -m pip install -e ".[speech]"

Ini memasang gTTS dan playsound==1.2.2. Tanpa tambahan ini program berfungsi tanpa bunyi.

Jalankan dan uji

python -m flash_card
python -m pytest

Ujian tetingkap dalam tests/e2e/ dilangkau apabila tiada paparan.

Muat turun fail boleh laku (Windows)

Muat turun flash-card.exe dan flash-card.exe.sha256 daripada halaman keluaran. Bandingkan cincangan SHA-256 fail dengan fail semak jumlah (certutil -hashfile flash-card.exe SHA256 pada Windows). Fail tidak ditandatangani, jadi Windows mungkin menunjukkan amaran SmartScreen.

Bina fail boleh laku (Windows)

python -m pip install -e ".[build,speech]"
python tools/build_executable.py

Skrip menggunakan PyInstaller dan menulis dist/flash-card.exe: satu fail tanpa tetingkap konsol, dengan imej, senarai perkataan dan suara di dalamnya. Klik dua kali untuk memulakan; Python tidak diperlukan untuk menjalankannya.

  • Kemajuan anda disimpan dalam folder data/ di sebelah fail boleh laku (data/words_to_learn.csv).
  • data/ms-da.csv di sebelah fail boleh laku menggantikan senarai perkataan di dalamnya.
  • python tools/build_executable.py --no-speech meninggalkan pakej suara; --clean membina semula dari awal.
  • Fail boleh laku tidak disimpan dalam repositori. Bina di sistem tempat ia akan dijalankan; Windows mungkin menunjukkan amaran SmartScreen kerana fail tidak ditandatangani.

Dokumentasi kod sumber

doxygen Doxyfile

HTML ditulis ke docs/doxygen/html/index.html.