Készíts áttekinthető README fájlt 10 perc alatt a GitHub Copilot segítségével

Nyisd meg a tárolódat és kezdd el a README fájlt

Nyisd meg a tárolódat a GitHubon a böngésződben. A főoldalra kerülsz, ahol a projektfájljaid láthatók. Keresd meg a fájlok listáját; ha épp most hoztad létre a tárolót, akkor lehet, hogy csak egy .gitignore fájlt vagy még semmit sem látsz. A fájllista jobb felső sarkában kattints az Add file (Fájl hozzáadása) gombra, majd válaszd a Create new file (Új fájl létrehozása) lehetőséget. Nevezd el a fájlt README.md-nek. Az .md a „Markdown” rövidítése, ami egy egyszerű módja a szöveg formázásának olyan szimbólumokkal, mint a # a címsorokhoz.

Látni fogsz egy üres szerkesztőt egy helyőrzővel: „Write a new file in …”. A README.md fájlnév jelzi a GitHubnak, hogy ez a projekt üdvözlőoldala.

Onnan tudod, hogy sikerült, hogy a szerkesztő tetején látod a README.md fájlnevet, és az oldal címe „Create new file” (Új fájl létrehozása).

Kérd meg a Copilotot, hogy generálja a README szerkezetét

A megnyitott fájl mellett nyomd meg az Ask Copilot (Kérdezd a Copilotot) gombot (általában egy chat ikon vagy egy csillogó jel) a szerkesztő jobb felső sarkában. Ha nem látod, keresd meg a Copilot ikont az eszköztáron, vagy használd a Ctrl+I (Windows/Linux) vagy Cmd+I (Mac) gyorsbillentyűt. Egy chat panel nyílik meg jobbra.

A chat mezőbe írd be:

Nyomd meg az Entert. A Copilot egy javasolt szerkezettel válaszol, Markdown címsorokkal, mint például # Description (Leírás), ## Features (Funkciók), stb. Lehet, hogy minden címsor alá egy rövid helyőrző bekezdést is hozzáad.

Onnan tudod, hogy sikerült, hogy címsorok és rövid leírások listája jelenik meg a szerkesztőben, felváltva az üres oldalt.

Töltsd ki a projektleírást

Görgesd a Copilot által létrehozott # Description (Leírás) szakaszhoz. Cseréld ki a helyőrző szöveget a projekted egyértelmű, egy mondatos magyarázatára. Például, ha a projekted egy Python szkript, ami szavakat számol, írd be:

Onnan tudod, hogy sikerült, hogy a leírás barátságos bevezetőként hat, és természetesen illeszkedik a címsor alá.

Sorold fel a projekt funkcióit

A ## Features (Funkciók) címsor alatt a Copilot valószínűleg egy felsorolást adott hozzá. Cseréld ki az egyes pontokat egy rövid, aktív kifejezésre, amely leírja, mit csinál a projekted. Egy szószámláló esetében így nézhet ki:

• Működik .txt fájlokkal Windows, macOS és Linux rendszereken
• Könnyű és másodpercek alatt fut
• Nincs szükség külső könyvtárakra

Onnan tudod, hogy sikerült, hogy a lista világosan megmutatja, mire képes a projekt, egyszerű nyelven.

Add hozzá a telepítési útmutatót

Görgesd a ## Installation (Telepítés) szakaszhoz. A Copilot általában olyan parancsokat javasol, mint a pip install vagy a git clone. Cseréld ki a helyőrzőt lépésről lépésre szóló utasításokra az operációs rendszeredhez. Egy kezdőbarát Python projekthez írd be:

python --version Ha Python 3.x-et látsz, mehet a munka. 2. Töltsd le vagy klónozd ezt a projektet: git clone https://github.com/your-username/your-repo.git 3. Lépj be a projekt mappájába: cd your-repo 4. Telepítsd a szükséges csomagot (ha van): pip install -r requirements.txt (Ha nincs requirements.txt fájl, hagyd ki ezt a lépést.)

Onnan tudod, hogy sikerült, hogy az utasítások elég világosak ahhoz, hogy egy alapvető számítógépes ismeretekkel rendelkező személy is kövesse őket anélkül, hogy összezavarodna.

Írj egy használati példát

A ## Usage (Használat) címsor alatt a Copilot gyakran hozzáad egy kódblokkot egy olyan paranccsal, mint a python wordcounter.py. Cseréld ki egy egyszerű, másolható-beilleszthető példára. Egy szószámláló esetében írd be:

python wordcounter.py sample.txt

Onnan tudod, hogy sikerült, hogy a példa rövid, valós fájlneveket használ, és pontosan megmutatja, mit kell beírni.

Válassz licencet és add hozzá

Görgesd a ## License (Licenc) szakaszhoz. A Copilot javasolhat egy helyőrzőt, például „MIT License” vagy „Apache 2.0”. Cseréld ki egy rövid magyarázatra és a licencfájlra mutató linkre. Kezdőknek az MIT License egyszerű és széles körben használt. Írd be:

Onnan tudod, hogy sikerült, hogy a licenc szakasz egyértelműen megadja a licenc típusát, és hivatkozik egy LICENSE nevű fájlra a tárolódban.