GitHub használata a projekthez
A GitHub az a hely, ahol az összes projektfájl, firmware és dokumentáció tárolva van és verziózva marad. Használhatod letöltésre, hozzájárulásra, vagy hibák jelentésére a Smart Auto-Watering Pot projekthez.
1. Amire szükséged van
- (Opcionális) Egy GitHub-fiók → Hozz létre egyet itt
- Egy számítógép webböngészővel (Chrome, Edge, Firefox)
- (Opcionális) Telepített Git, ha parancssorból szeretnél klónozni
2. A projektfájlok letöltése
A firmware és a dokumentáció legfrissebb verzióját a repositoryból töltheted le:
- Látogass el a github.com/mechaxil oldalra, vagy nyisd meg közvetlenül a projekt dokumentációs oldaláról.
- Kattints a Code → Download ZIP gombra.
- Csomagold ki a ZIP fájlt valahova a számítógépeden.
Alternatívaként, ha a Git telepítve van, közvetlenül is klónozhatod:
git clone https://github.com/mechaxil/smart-auto-watering-pot.git
3. Fájlok böngészése és szerkesztése online
A fájlokat közvetlenül a böngészőből is olvashatod vagy szerkesztheted:
- Navigálj a mappák között, például a
firmware/vagydocs/könyvtárakban - Kattints a ceruza ikonra egy módosítás javaslatához; a GitHub automatikusan létrehoz egy forkot
- Mentsd el a módosítást, és a GitHub javasolni fog egy Pull Requestet ellenőrzésre
4. Hibák jelentése vagy fejlesztési javaslatok
Ha találtál egy problémát vagy van egy ötleted:
- Menj az Issues fülre
- Kattints a New Issue gombra
- Válaszd ki a legmegfelelőbb sablont
- Töltsd ki érthetően, és ha lehet, csatolj képernyőképet is
5. Hozzájárulás Pull Requestekkel
Ha módosítottad a kódot, firmware-t vagy dokumentációt:
- Forkold a repositoryt
- Végezd el a módosításokat
- Commitold a változtatásokat rövid, leíró üzenettel
- Nyiss egy Pull Requestet a forkodból a fő repository felé
A csapat rendszeresen átnézi a hozzájárulásokat, és a kisebb javításokat is értékeljük, például az elgépelések javítását.
6. Következő lépések
Miután letöltötted a projektet, készen állsz a firmware feltöltésére a mikrokontrolleredre.