diff --git a/README.md b/README.md index 3743c98..37734aa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Knihovna -# Jak přidávat vaši práci - ## Struktura projektu Projekt je organizován do několika klíčových částí: @@ -29,15 +27,18 @@ Knihovna/ ## Popis hlavních souborů ### `./src/` + - Každá **funkce** nebo **část logiky** musí být implementována **v samostatném souboru**. - Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`. - Tento přístup zajišťuje přehlednost, modularitu a snadné testování. ### `Database.cs` + - Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`). - Není vhodné měnit strukturu bez předchozí domluvy s ostatními členy týmu, protože soubor je sdílený v rámci celého projektu. ### `Program.cs` + - Slouží jako **hlavní vstupní bod** aplikace. - Zde se spouští program, načítají data a volají funkce z adresáře `src`. - Tento soubor zajišťuje propojení všech částí projektu. @@ -46,16 +47,18 @@ Knihovna/ ## Postup při přidávání vaší práce -### 1️⃣ Klonování repozitáře +### Klonování repozitáře Stáhněte si projekt lokálně pomocí GITu: ```bash git clone https://gitea.homework.zip/shinya/Knihovna.git ``` + Tímto příkazem vytvoříte lokální kopii projektu na vašem počítači. ## Úpravy a implementace + Vytvořte nebo upravte soubory v adresáři ./src/. Dodržujte strukturu projektu a konvence psaní kódu. @@ -63,6 +66,7 @@ Dodržujte strukturu projektu a konvence psaní kódu. Průběžně testujte své změny (např. pomocí dotnet run). ## Commit a push + Jakmile máte změny hotové, proveďte následující příkazy: ```bash @@ -70,6 +74,7 @@ git add . git commit -m "Implementace funkce vyhledávání knih" git push ``` + Tímto nahrajete změny zpět na server. Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projektu: @@ -77,9 +82,11 @@ Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projekt ```bash git pull ``` + - a vyřešte případné konflikty, pokud se vyskytnou. ## Zadání projektů + V adresáři ./docs se nachází zadání pro jednotlivé týmy. Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuje: @@ -114,10 +121,10 @@ Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuj ## Funkce - GetBooks() param. filter wrapper function, pick if by name or author - - GetBooksByAuthor() param. filter - - GetBooksByName() param. filter - - GetStolenBooks() param. filter - - GetAvailableBooks() param. filter + - GetBooksByAuthor() param. filter + - GetBooksByName() param. filter + - GetStolenBooks() param. filter + - GetAvailableBooks() param. filter - GetBorrowedBooks() param. userID - GetBookInfo() param. knihaID - AddBook() param. KnihaInfo