diff --git a/README.md b/README.md index 008d93a..74941c9 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,53 @@ - WorldPlace.cs: Building guid duplikacio check, rotation/localPosition fix - AddVillagerPacket.cs: Villager position sync + duplikacio check - Main.cs: BakePathing() hozzaadva PlayerAddBuildingHook-ban + +--- + +## README.md Dokumentációs Hibák + +> **FIGYELEM**: Ez a szekció a README.md fájlban található dokumentációs hibákat listázza. +> Ezek a hibák **NEM** lettek javítva, csak dokumentálva vannak. + +### Nyelvtani Hibák - Hiányzó Ékezetek + +| Hiba helye | Jelenlegi szöveg | Helyes forma | Javítás módja | +|------------|------------------|--------------|---------------| +| **Line 3** | "Ismert hibak" | "Ismert hibák" | 'a' → 'á' | +| **Line 7** | "Megjegyzes" | "Megjegyzés" | 'e' (első) → 'e', 'e' (második) → 'é' | +| **Line 41** | "Definiciok" | "Definíciók" | 'i' (második) → 'í', 'o' → 'ó' | +| **Line 48** | "Analisis" | "Analízis" | 'i' (második) → 'í' | +| **Line 59** | "Idovonal" | "Idővonal" | 'o' → 'ő' | +| **Line 88** | "duplikacio" | "duplikáció" | 'a' → 'á', 'o' → 'ó' | + +**Hol kell javítani**: README.md fájl, a fenti sorokon +**Miért fontos**: A magyar helyesírási szabályok betartása, professzionális megjelenés + +### Strukturális Hiányosságok + +| Probléma | Leírás | Javasolt megoldás | +|----------|--------|-------------------| +| **Hiányzó bevezető** | A dokumentum azonnal a bug listával kezdődik | Adj hozzá egy "## Áttekintés" szekciót a fájl elejére, amely elmagyarázza mi ez a dokumentum és mire való | +| **Hiányzó kontribúciós útmutató** | Nincs információ arról, hogyan lehet új bugokat jelenteni | Adj hozzá egy "## Hogyan jelentsek új bugot?" szekciót utasításokkal | +| **Verzió információ hiánya** | A "Recent Changes" szekcióban nincs verzió szám | Fontold meg verzió számok hozzáadását (pl. v0.1.0) minden változtatáshoz | + +**Hol kell javítani**: README.md struktúra és szervezés +**Miért fontos**: Könnyebb navigáció, jobb felhasználói élmény + +### Konzisztencia Problémák + +| Probléma | Példa | Megjegyzés | +|----------|-------|------------| +| **Magyar-angol keverés** | "output.txt-bol", "NullReferenceException" | Technikai kifejezések angolul vannak, ami elfogadható, de a magyar toldalékok (-bol, -ben) inkonzisztensek | +| **Táblázat formázás** | Egyes táblázatok szélesebbek mint mások | Egységesítsd a táblázat oszlopszélességeket | + +**Hol kell javítani**: README.md szövegformázás +**Miért fontos**: Egységes megjelenés, könnyebb olvashatóság + +--- + +### Javítási Prioritások + +1. **MAGAS**: Ékezetek javítása (line 3, 7, 41, 48, 59, 88) +2. **KÖZEPES**: Bevezető szekció hozzáadása +3. **ALACSONY**: Verzió információk és kontribúciós útmutató hozzáadása