Nowe README.md

Author: Kulezi

README.md

@@ -1,10 +1,53 @@
-# OI
-Archiwum moich rozwiązań do zadań z Olimpiady Informatycznej.
+# Materiały przygotowujące do Olimpiady Informatycznej.
+
+## Repozytorium ma na celu:
+- Przekazanie wiedzy przydatnej w Olimpiadzie Informatycznej dla wszystkich chętnych do nauki.
+- Promowanie systematycznego podejścia do treningu i zdrowych nawyków.
+- Zapewnienie prostych, przystępnych narzędzi do mierzenia swojego progresu
+- Naukę powszechnie stosowanych narzędzi programistycznych poprzez praktykę.
+
+## Repozytorium zawiera:
+- Rozwiązania zadań z Olimpiady Informatycznej, które napisałem, często alternatywne do omówień ze strony OI.
+- Skrypty linuksowe przydatne na olimpiadzie z prostym wytłumaczeniem każdej instrukcji.
+- Krótkie wykłady na temat korzystania z narzędzi linuksowych przydatnych w pisaniu i testowaniu zadań.
+- Automatycznie aktualizujący się licznik rozwiązanych zadań oraz tabelę pokazującą, 
+które zadania z każdej z edycji OI zostały już rozwiązane z podziałem na etapy olimpiady. 
+Przydaje się to do mierzenia progresu, oraz do doboru zadań na treningu. 
+- Odnośniki do innych przydatnych źródeł.
+
+
+## Struktura repozytorium:
+
+Zawartości katalogów `skrypty`, oraz `materialy` łatwo się domyślić, zachęcam do zapoznania się z nią.
+W katalogu `rozwiazania` znajdziesz wszystkie rozwiązania zadań z OI, które zaimplementowałem.
+Katalog `rozwiazania/<edycja_oi>/<etap_oi>/[dzień_etapu]/<skrót zadania>` zawiera pliki dotyczące danego zadania z OI.
+- `<skrót zadania>.cpp` - moje rozwiązanie zadania, które otrzymuje 100 pkt na testach na sio2/szkopule, 
+        dodatkowo z dopiskiem `_alt` bądź `_oi` pojawiają się czasem rozwiązania alternatywne oraz wprost z omówienia zadania,
+        w przypadkach gdy rozwiązałem zadanie na 100 punktów na kilka różnych sposobów.
+- `<skrót zadania><liczba punktów>.cpp` - Rozwiązania, które dostają mniej niż 100 punktów, takie jak bruty, bądź rozwiązania podgrup.
+I dosyć często również pliki: 
+- `<skrót zadania>g.cpp` - moja generatorka do zadania, której używałem testując rozwiązanie.
+- `<skrót zadania>chk.cpp` - moja czekerka w przypadku zadań, w których istnieje więcej niż jedno poprawne rozwiązanie inne niż generowane przez bruta.
+- Katalog `virtual_contest/`, zawierający moje skrypty, generatorki, czekerki i różne podejścia do zadania w przypadku, gdy symulowałem ograniczenia czasu i widoczności werdyktów występujące na olimpiadzie, tzn. w przypadku etapów I i II olimpiady, nie mogłem poznać liczby punktów, które dostanie moje zadanie na sprawdzarce szkopuł. Testowałem rozwiązanie lokalnie, i wysyłałem dopiero po przetestowaniu. Rozwiązania zadań z III etapu mogłem wysłać do 10 rozwiązań na szkopuła poznając ich wynik.
+
+Katalogi `checklista` oraz `.github` zawierają skrypty automatycznie generujące checklisty, nie należy ich modyfikować. 
+Jeśli coś nie działa, daj mi znać przez [Issue](https://github.com/Kulezi/oi/issues) na GitHubie.
+
+Przykładowo katalog `rozwiazania/xxv/etap3/dzien1/kom/` będzie zawierał moje rozwiązania do zadania 'Liczby kompletne' z III etapu XXV OI.
+Rozwiązania konkretnego zadanie można łatwo znaleźć sprawdzając, z której edycji i etapu olimpiady jest na [Liście zadań OI](https://oi.edu.pl/l/oi_zadania/),
+bądź przy pomocy polecenia `grep 'nazwa zadania' -R .` wywołanego z głównego katalogu repozytorium, np. `grep `Trójkąty` -R .`.
+
+## Jak samemu skorzystać z checklisty:
+
+Sforkuj [szablon](https://github.com/testowyuczen/oi) tego repozytorium [klikając tutaj](https://github.com/testowyuczen/oi/fork),
+i przy wbiciu jakiegoś zadania, np 'Rycerz:wq' z pierwszego dnia II etapu XXXI OI:
+- Zapisz rozwiązanie. np. w pliku `rozwiazania/xxxi/etap2/dzien1/ryc/ryc.cpp`.
+- Dodaj je do repozytorium wykonując `git add `rozwiazania/xxxi/etap2/dzien1/ryc/ryc.cpp`, (przy pomocy `git status` możesz zobaczyć co już dodałeś w tym commicie).
+- Scommituj je np. w ten sposób: `git commit -m "Dodano rozwiązanie zadania 'Rycerz' z XXXI OI"` (jeśli zapomnieliśmy czegoś dodać wystarczy powtórzyć poprzedni krok i użyć `git commit --am`.
+- Zaktualizuj repozytorium na GitHub o lokalne zmiany przy pomocy `git push`, ewentualnie `git push -f`.
+- Checklista w `README.md` na GitHub zaktualizuje się automatycznie w ciągu kilku minut.
+- `git pull` wciągnie aktualną wersję checklisty z GitHuba (bez tego będziesz potrzebował robić `git push -f` przy każdym pushu.
 
-Katalog `<edycja>/<etap>/<skrót zadania>` zawiera:
-- `<skrót zadania>.cpp` moje rozwiązanie, które otrzymuje 100 pkt na testach na sio2/szkopule.
-- `<skrót zadania><liczba punktów>.cpp` moje rozwiązania z olimpiady, które dostały mniej niż 100 punktów na zawodach.
-- Katalog `virtual contest/`, zawierający moje skrypty, generatorki, czekerki i różne podejścia do zadania w przypadku, gdy symulowałem ograniczenia czasu i widoczności werdyktów występujące na olimpiadzie, tzn. w przypadku etapów I i II olimpiady, nie mogłem poznać liczby punktów, które dostanie moje zadanie na sprawdzarce szkopuł. Testowałem rozwiązanie lokalnie, i wysyłałem dopiero po przetestowaniu. Rozwiązania zadań z III etapu mogłem wysłać do 10 rozwiązań na szkopuła poznając ich wynik.
 <!-- AUTO-CHECKLIST -->
 
 > ⚠️ **UWAGA:** Sekcja poniżej jest generowana automatycznie.