1. tēma: 1.5 Dokumentēšana, README un Licences

Tavs šīs stundas izaicinājums: Izvēlēties un pievienot atvērtā pirmkoda licenci savai krātuvei, pielietot Markdown valodu un sastādīt profesionālu projekta aprakstu (README).

2.4.6. Plāno un dokumentē programmatūras izstrādes procesu.
2.4.8. Dokumentē kodu un ievero koda noformēšanas vadlīnijas.

Teorija: Koda tiesības un Dokumentācija

Kad tu publicē kodu internetā (pat publiskā GitHub krātuvē), citi cilvēki to drīkst tikai lasīt. Lai citi drīkstētu tavu kodu izmantot, pārveidot vai dalīties ar to, tev ir jāpievieno Licence.

Bez licences: Kods ir pilnībā aizsargāts ar autortiesībām (Exclusive Copyright). Neviens cits to nedrīkst kopēt vai izmantot savos projektos.
MIT Licence: Vispopulārākā atvērtā pirmkoda licence. Ļauj citiem darīt ar tavu kodu jebko (arī pārdot), ja vien viņi norāda tevi kā sākotnējo autoru.
GPL (GNU General Public) Licence: Ļauj citiem izmantot tavu kodu, bet ar stingru nosacījumu — jebkurš jauns projekts, kas izmanto tavu kodu, arī ir jāpublicē kā atvērtais pirmkods.
README.md: Projekta "seja". Fails, kas automātiski parādās tavas GitHub krātuves sākumlapā. Faila paplašinājums .md nozīmē Markdown — vieglu teksta formatēšanas valodu.

1. uzdevums: Licences ģenerēšana GitHub mākonī

Izmanto GitHub iebūvētos rīkus, lai automātiski izveidotu juridiski korektu licences failu savam projektam.

Izpildes soļi:

Pārlūkprogrammā atver github.com un dodies uz savu programmesana-pamatkurss krātuvi.
Nospied pogu Add file (virs failu saraksta) un izvēlies Create new file.
Faila nosaukuma laukā precīzi ieraksti vārdu: LICENSE (ar lielajiem burtiem).
Ekrāna labajā pusē parādīsies poga Choose a license template. Nospied to.
Izvēlies MIT License, nospied Review and submit, un tad lapas apakšā nospied zaļo pogu Commit changes....

2. uzdevums: Sinhronizācija (Pull) no mākoņa

Tā kā licenci izveidoji internetā, tavs lokālais dators par to vēl neko nezina. Mums koda izmaiņas ir "jāpaņem" (Pull) atpakaļ.

Izpildes soļi:

Atver GitHub Desktop programmu.
Augšējā joslā nospied Fetch origin. Programma pārbaudīs, vai internetā ir jaunas izmaiņas.
Poga nomainīsies uz Pull origin (ar bultiņu uz leju). Nospied to, lai lejupielādētu LICENSE failu savā datorā.
Nospied Open in Visual Studio Code un pārliecinies, ka LICENSE fails tagad atrodas tavu failu sarakstā kreisajā pusē.

3. uzdevums: Profesionāla README.md izveide

Izmanto Markdown sintaksi, lai izveidotu skaidru aprakstu par to, kas šī ir par krātuvi un kādi ir tās noteikumi.

Izpildes soļi:

VS Code atver failu README.md un izdzēs esošo tekstu.
Pievieno galveno virsrakstu: # Programmēšanas pamatkurss.
Pievieno apakšvirsrakstu un aprakstu:
## Par projektu
Šī ir mana repozitorija vidusskolas programmēšanas kursam. Šeit atrodas visi mani mācību kodi.
Pievieno sarakstu ar apakšvirsrakstu:
## Struktūra
- **teorija/** - Mani pieraksti un koda paraugi
- **uzdevumi/** - Praktisko darbu faili
Pievieno atsauci uz savu jauno licenci:
## Licence
Šis projekts izmanto [MIT Licenci](LICENSE).
Saglabā failu. Izmanto Ctrl + Shift + V, lai redzētu priekšskatījumu.

Papildus uzdevums: Fiksēšana un Augšupielāde (Push)

Noslēdz darba ciklu, saglabājot jauno dokumentāciju izmaiņu vēsturē un nosūtot to atpakaļ uz GitHub.

Izpildes soļi:

Atver GitHub Desktop. Izmaiņu sarakstā (Changes) jābūt redzamam tavam modificētajam README.md failam.
Sastādi profesionālu kopsavilkumu (Summary): Pievienota projekta struktūra un licences info README failā.
Nospied Commit to main.
Nospied Push origin. Dodies uz pārlūkprogrammu, atsvaidzini (Refresh) savu GitHub lapu un apbrīno savu jauno, profesionāli formatēto projekta titullapu!

Biežākās kļūdas (un kā tās labot):

Licence nesaglabājas: Ja GitHub mājaslapā failu nenosauksi precīzi par LICENSE (ar lielajiem burtiem), sistēma nepiedāvās "Choose a license template" pogu.
Konflikti (Merge Conflicts): Ja izmainīsi README.md GitHub mājaslapā un vienlaicīgi izmainīsi to pašu failu savā datorā (VS Code), mēģinot sinhronizēt radīsies konflikts. Risinājums: Vienmēr taisi Fetch origin pirms sāc strādāt!
Markdown virsraksti nestrādā: Starp tēmturi # un pašu tekstu OBLIGĀTI jāatstāj atstarpe. (#Virsraksts = parasts teksts, # Virsraksts = liels virsraksts).

Koda piemērs: README faila izejkods

# Mans Superīgais Projekts

Šī ir programma, kas atrisina visas pasaules problēmas.

## Kā to lietot?
Vienkārši palaid `main.py` failu savā terminālī. Tas izskatās šādi:
```python
print("Projekts darbojas!")
Noteikumi
Projektam ir MIT Licence, kas nozīmē, ka vari to izmantot brīvi! Vairāk lasi failā LICENSE.

Izmantojot backticks (`), tekstā var integrēt kodu (Inline code), bet ar trim backticks (```) var izveidot veselus koda blokus, ko GitHub iekrāsos atbilstoši valodai.