README egy projekthez

Kész a kód, de senki nem tudja elindítani? Rövid, követhető README telepítéssel, használattal és a leggyakoribb hibákkal.

FejlesztésKezdőAjánlott eszközök: ChatGPT, Claude, Gemini, CopilotFrissítve:

Töltsd ki a saját adataiddal

A sárgával jelölt részeket cseréld a saját adataidra.

Írj README fájlt egy szoftverprojekthez Markdown formátumban. Mit csinál a projekt, egy-két mondatban: [PROJEKT] Kinek szól: [FELHASZNÁLÓ] Mi kell a futtatáshoz (nyelv, verzió, függőségek): [KÖVETELMÉNYEK] Hogyan telepítem és indítom el, a saját szavaimmal: [INDÍTÁS] Ismert korlátok vagy gyakori hibák: [KORLÁTOK] Felépítés: 1. Név és egy mondat arról, mire jó. 2. Gyors kezdés: a legkevesebb lépés az első működő futásig, kódblokkban. 3. Követelmények. 4. Használat két-három példával. 5. Beállítások táblázatban: név, mire való, alapérték. 6. Gyakori hibák és megoldásuk. 7. Hogyan lehet hozzájárulni vagy hibát jelenteni. Csak olyan parancsot írj, amely a megadott leírásból következik. Ahol nem tudod biztosan, jelöld így: TODO: ellenőrizni. Jelvényeket, díszítést és reklámszöveget ne tegyél bele.

EllenőrzésCtrl + Enter: másolás

Példa: kitöltve, mintaválasszal

Projekt
Parancssoros eszköz, amely egy mappa képeit átméretezi és WebP formátumba menti.
Felhasználó
Kis weboldalak üzemeltetői.
Követelmények
Python 3.11 vagy újabb, Pillow csomag.
Indítás
pip install -r requirements.txt, aztán python kepek.py bemenet kimenet --szelesseg 1200
Korlátok
HEIC fájlokat nem kezel. Nagy mappánál lassú.
Mintaválasz (Claude)
# kepek

Egy mappa képeit átméretezi, és WebP formátumba menti.

## Gyors kezdés
```
pip install -r requirements.txt
python kepek.py bemenet kimenet --szelesseg 1200
```

## Követelmények
- Python 3.11 vagy újabb
- Pillow

## Használat
```
python kepek.py fotok web --szelesseg 800
```
A `fotok` mappa képeit 800 képpont szélesre méretezi, és a `web` mappába menti.

## Beállítások
| Név | Mire való | Alapérték |
|---|---|---|
| `--szelesseg` | a kimeneti kép szélessége képpontban | TODO: ellenőrizni |

## Gyakori hibák
- **HEIC fájl kimarad:** ezt a formátumot az eszköz nem kezeli; előbb alakítsd JPG-re.
- **Lassú:** nagy mappánál a feldolgozás sokáig tarthat.

## Hibajelentés
TODO: ellenőrizni, hol fogadtok hibajelentést.

Szemléltető minta, Claude segítségével készült: azt mutatja, milyen jellegű és felépítésű válaszra számíthatsz. A többi ajánlott eszközzel a prompt várhatóan ugyanígy használható, de nem mindegyikben próbáltuk ki. A te eredményed más lesz. Hogyan készülnek a példák?

Miért működik?

A README első tíz sora dönti el, kipróbálja-e valaki a projektet. A „gyors kezdés" azért kerül előre, mert az olvasó előbb futtatni akar, és csak utána olvas. A TODO jelölés megakadályozza, hogy a modell kitaláljon egy alapértéket vagy egy nem létező kapcsolót.

Mire figyelj?

  • A parancsokat futtasd le egy tiszta környezetben, mielőtt közzéteszed; a README hibája az első benyomást rontja el.
  • Jelszót, API-kulcsot és belső címet ne hagyj a példákban.

Folytasd ezekkel

Ugyanabban a beszélgetésben küldd el, a válasz után.

  • Írd meg angolul is.
  • Adj hozzá egy rövid változásnaplót az első verzióhoz.

Kapcsolódó promptok

Összes fejlesztés prompt

Funkció specifikálása kódolás előtt

Mielőtt kódot kérnél az AI-tól, írasd meg vele a tervet. A prompt kérdésekkel tisztázza az ötletedet, majd rövid specifikációt készít elfogadási feltételekkel.

Fejlesztés