Readme.md

To opis całego projektu. Ten plik to zalążek dokumentacji. Można go dodać już na początku projektu – wraz z tworzonym repozytorium. Informuje innych, o czym jest projekt, co z nim mogą zrobić i jak korzystać. Jest pierwszym elementem, jaki zobaczą, wchodząc do repozytorium. Musi zawierać podstawowe informacje o nim. To taka reklama Waszego kodu.

Warto wyćwiczyć sobie nawyk zamieszczania zgrabnego pliku README. Dlaczego? Właśnie dlatego, aby był to Twój nawyk, poza tym, jak wspomniałam nie raz GITHUB to takie Twoje portfolio, wizytówka. Kiedy będziesz szukać pracy, rekruterzy IT szukają swoich kandydatów zwłaszcza na GITHUB-e, patrzą jakie projekty tam się znajdują, jak napisane i, czy działasz zgodnie z ogólnie przyjętymi zasadami.

Co to za rozszerzenie pliku .md ? To od słówka markdown – język znaczników, który służy do formatowania tekstów. Może wygląda groźnie, ale jest całkowicie prosty. Więcej na temat tego języka znajdziecie na Wiki.
Oczywiście na GITHUB-e znajdziecie pomocną stronkę – o tu, jak posługiwać się nim w pliku README.
Edytor online tego języka znajdziecie na stronie https://dillinger.io/

Gotowy szablon wraz z wszystkimi nagłówkami, spisem treści, informacjami co i jak wpisać znajdziecie o tu.
Kopiując wersję RAW do swojego pliku Readme.md możecie spokojnie edytować szablon.

Nad czym warto się zastanowić i co wpisać? Między innymi nad:

• Tytuł, śródtytuły – świetnie robi się wtedy spis treści z linkami do poszczególnych części dokumentu, 
• Wprowadzenie – cel projektu, po  go w ogóle robisz? Uczysz się nowej technologii? Chcesz przećwiczyć tworzenie pewnych schematów?
• Technologie – czego używasz? Jakich języków lub frameworków, bibliotek? Wersje danych technologii też warto wpisać. Dlaczego takich języków się używa, a nie innych? 
• Uruchomienie – jak uruchomić projekt? Jakieś szczególne środowisko jest potrzebne? Wymagania sprzętowe.

Można dodać również:

• Spis treści – z linkami odsyłającymi,
• Ilustracje – zawsze lepiej coś pokazać na obrazku jak coś działa, a nasz mózg lubi obrazy, lepiej je zapamiętuje. Ilustrowana instrukcja obsługi? Czemu nie?
  
  Pomocny będzie schemat:
   – gdy zdjęcie/ilustracja jest w folderze na GITHUB-e
  lub
   – gdy używamy zdjęcia ogólnodostępnego
  
• Funkcjonalności – jakie funkcje spełnia projekt? Jakie opcje są dostępne?
• Przykłady użycia – schemat, jaki trzeba użyć, bo projekt zadziałał,
• Status – projekt jeszcze się rozwija? Czy to już skończona historia?
• Źródła – z jakich źródeł korzystaliśmy? Jakie tutoriale były pomocne? Gdzie szukaliśmy inspiracji do rozwiązania jakiegoś problemu?
• Inne informacje – informacje o autorze, linki do social mediów, strona www autora, na jakiej zasadzie można używać Twojego kodu itp.

.gitignore

To plik konfiguracyjny wskazujący na pliki, które ma ignorować GIT podczas commitowania. Dlaczego? Aby sprawniej się pracowało. Używamy go, gdy nie chcemy czegoś w repozytorium, np. plik, który powstaje po kompilacji css do sass.  Można takie pliki również wykluczyć – Exclude .
Jak stworzyć taki plik .gitignore? Są dwie możliwości. Pierwsza z nich jest banalnie prosta i polega na zaznaczeniu tej opcji przy tworzeniu repozytorium.
Druga wymaga trochę więcej pracy i kodu. Znalazłam prostą instrukcję, więc nie będę jej przepisywać. Znajduje się ona na blogu Keep Calm And Try Coding. Kreator, o którym wspomina autorka, można znaleźć poniżej:

Kreator pliku .gitignore.

Co to u licha jest?

.gitkeep

Wskazuje na foldery również puste, które powinny być wysłane do repozytorium. Niestety, jeśli folder jest pusty, GIT go ignoruje domyślnie. Aby temu przeciwdziałać, tworzymy plik o nazwie .gitkeep w danym folderze – nie jest on już pusty i wszystko gra i buczy. Sukces! Proste i logiczne. Nazwa tego pliku wskazuje na to, że nie jest to żaden kod czy inna ważna sprawa. Można ją zignorować.

Co ciekawe można ten plik wykorzystać nawet w takiej sytuacji, gdy chcemy wysłać do repozytorium sam folder bez zawartości. Wymaga to utworzenie .gitkeep w danym folderze i dopisania kodu do pliku .gitignore

#ignore files in folder
foo/*

#but keep the folder
!foo/.gitkeep

Takie rozwiązanie znalazła o tu

Pliki, o których warto jeszcze sobie doczytać to z pewnością: .gitconfig oraz .gitattributes.
Ten pierwszy plik odpowiada za konfigurację GIT-a (w nim wpisywaliśmy nasz email i nasze dane). Można o nim poczytać ciut więcej o tu.
Drugi z kolei to plik, dzięki któremu używając atrybutów, możesz np. określić oddzielne strategie scalania dla pojedynczych plików lub katalogów w projekcie, powiedzieć Git, jak odróżnić pliki nietekstowe, lub zmienić zawartość filtra Git, zanim zaczniesz go sprawdzać lub usuwać z Git. Więcej informacji na ten temat znalazłam o tu.

To by było na tyle tym razem. Jak zwykle chciałam napisać tylko podstawy podstaw, a już wychodzi mi ponad 700  słów… Będzie część czwarta. Z komendami, które przydają się w codziennym użytkowaniu GIT-a.

I jeszcze jedna fajna rzecz. Maciej Aniserowicz tworzy „kurs Gita”. Można zapisać się na listę mailingową. To kurs płatny, lecz z pewnością pieniądze będą bardzo dobrze wydane. Maciej prowadzi bloga i vloga devstyle.pl

Artykuł Przeczytaj mnie… pochodzi z serwisu To co najważniejsze.

Od czego zacząć?

Na samym początku warto zastanowić się, co nam będzie potrzebne, do czego ten komputer nam ma służyć. Czy będziemy go używać do obróbki zdjęć i audio, a może do buszowania po sieci? Czy też może bardziej do pisania? 
Najlepiej spisać sobie kategorie programów, których będziemy potrzebować.

Lista przykładowych programów.

W pierwszej kolejności, zanim zaczniemy pakować na dysk nowe programy, a inne usuwać,  warto zainstalować menedżer pakietów – Synaptic. Pozwala on na instalację i reinstalację, odinstalowanie pakietów.
W terminalu wpisujemy:

$ sudo apt-got install synaptic

Jeśli chcemy usunąć jakiś program dostarczony wraz z instalacją systemu, używamy komendy:

$ sudo apt-get purge nazwa_pakietu/programu

Mamy dwie drogi instalacji programów: z oficjalnego repozytorium programów oraz tych spoza tego repozytorium. I mamy dwie metody instalacji programów: używając terminala (do czego zachęcam ;)) oraz menedżer programów.

Teraz wypiszę programy, które przydadzą się zawsze i wszystkim, niezależnie od upodobań (tak sądzę ;)).

• LibreOffice  – to pakiet biurowy. Jego odpowiednikiem jest windowsowy Office. Można oczywiście korzystać z dokumentów Google, ale ten pakiet jest dedykowany Linuksowi, dlatego warto się z nim zaznajomić choć trochę,
• Plan– program do zarządzania projektami, podobne programy to Planner, Agenda,
• Spotify – nie może go zabraknąć u nikogo, kto lubi sobie umilić pracę na komputerze jakąś miłą muzyczką lub ulubionymi podcastami,
• Clementine – to odtwarzacz audio,
• Indicator Stickynotes, Tomboy – notatniki, ten pierwszy to te sławne „żółte karteczki”,
• Glippy – multi-schowek,
•  DropBox – nie może go zabraknąć, podobnie jak dysku Google
• Chromium Web Browser – to przeglądarka Chrom na Linux-a,
• Facebook Masseger – komunikator Fb,
• MiniTube – program umożliwiający oglądanie materiałów z YouTube bez przeglądarki www,
• My Weather Indicator – pogodynka,
• Gimp – edytor grafiki,
• Labyrinth Mind-Mapping – program do map myśli,
• Easy SSH – program do kluczy SSH ( przydatne przy podpinaniu GitHuba),
• Tomato – aplikacja timer-pomodoro,
• HourGlass – aplikacja timer i alarmy,
• Blog Entry Poster – program do pisania postów na blog.
• Ubuntu-restricted-extras – pakiet kodeków, frontów windowskich,
• Keepassx -program do przechowywania haseł,
• Osmo – organizer,
• Gdebi – program do rozpakowywania pakietów .deb,
• Elementary Tweaks – program do ulepszeń.

Instalacja programów.

1. Programy z oficjalnego repozytorium.

Poza menedżerem programów możemy zainstalować pakiety z poziomu terminala. Przykładowa komenda:

$ sudo aptitude install nazwa_pakietu(programu)

Wyszukiwanie konkretnego programu w terminalu:

$ aptitude search nazwa_pakietu(programu)

2. Programy poza oficjalnego repozytorium

Najpierw trzeba dodać repozytorium:

$ sudo add-apt-repository ppa:user/ppa-name

Później aktualizujemy repozytorium:

$ sudo apt-get update

W końcu instalujemy program spoza oficjalnego repozytorium:

$ sudo apt-get install nazwa_programu(pakietu)

Aby usunąć taki pakiet/program trzeba wpisać w terminalu:

* Usuwamy wcześniej dodane repozytorium, ale zostawiamy w spokoju program.

$ sudo add-apt-get --remove ppa:nazwa_repozytorium_do_usunięcia/ppa

* Usuwamy repozytorium, program i przywracamy program z oficjalnego repozytorium.

$ sudo ppa-purge ppa: nazwa_repozytorium_do_usunięcia/ppa

Pakiety .deb

Aby zainstalować  pakiety .deb wykorzystujemy wspomniany wyżej  program Gdebi lub wpisujemy w terminalu:

$ sudo dpkg -i nazwa*.deb

Reinstalacja 

Reinstalację przeprowadzimy za pomocą programu Synaptic lub komendy:

$ sudo apt-get install --reinstall nazwa_pakietu

lub

$ sudo aptitude reinstall nazwa_pakietu

Myślę, że trochę nakierowałam Was, co można dodać do nowo zainstalowanego systemu Linux. W większości przypadków można te programy zainstalować poprzez menedżera programów. Dla chętnych przygotowałam spis komend instalujących pakiety, do wpisania w terminal. Warto jak najczęściej używać terminala, aby się oswoić z pewną specyfiką działania. Pozdrawiam.

Artykuł Linux-owy niezbędnik pochodzi z serwisu To co najważniejsze.