Här förklaras vilka verktyg som behövs, hur man använder dom och vilka filer som kan byggas. Det här repot innehåller mestadels TeX-relaterade filer som kan användas för att bygga/generera PDF-filer.
I det här dokumentet finns instruktioner om hur du kan hämta hem projektet och köra den på din egen dator. Den går igenom steg för steg och beskriver de verktyg som används för att köra koden.
| 💡 Tips |
|---|
| Kom ihåg att om du har problem kan du skapa ett nytt ärende på GitHub eller använda kontaktuppgifterna som finns i README.md. |
| Dessa instruktioner är inte fullständiga men kan ändå hjälpa fram för allt de som kör Linux eller UNIX-liknande operativsystem. Just nu är den här guiden mest inriktad på Linux/Debian-derivat men paketnamnen bör heta likadant i andra distributioners pakethanterare. |
Börja med att följa instruktionerna nedan för att installera verktygen Make och Git.
För att kunna hämta hem, arbeta med och köra projektet behöver du använda dig av versionshanteringssystemet Git och verktyget Make.
Linux/Debian
sudo apt-get install git make
Git är ett versionshanteringsverktyg som håller reda på historiken av kodutveckling. Den hjälper en kodare med arbetet genom smarta verktyg och möjligheten att utveckla kollaborativt.
Navigera till den mapp du vill ladda ner SSA-Akademin repot i. De som kör Git med grafiskt användargränssnitt (GUI) kan välja Clone och sedan URL:en i argumentet nedan. För de som kör med kommandotolken:
git clone https://github.com/SverigesSandareamatorer/SSA-Akademin.git
cd SSA-Akademin/
Make är ett program som används för att förenkla källkodsfiler till körbara filer och i det här fallet, till bl.a. PDF:er. Det gör att användaren av Make inte behöver veta hur genereringen går till utan bara vilket kommando som ska köras. Make används genom att köra kommandot ”make” följt av ett mål. Till exempel:
make koncept.pdf
Dessa Make ”mål” kräver vissa verktyg för att kunna köras och dessa kallas för beroenden. Dessa beroenden måste installeras innan Make ”mål:et” kan köras och instruktioner för vilka beroenden ett mål har hittar du under Make mål och Byggberoenden.
För att få en översikt över vilka mål som finns listas dom här i tabellen med en beskrivning om vad dom gör och vilka verktyg som de är beroende utav. För att köra ett Make mål, se till att du har installerat beroendet som det behöver.
| Mål | Bygger/Genererar | Beroende |
|---|---|---|
all |
alla mål | alla beroenden nedan |
clean |
Tar bort alla genererade filer | - |
koncept.pdf |
PDF av KonCEPT | TeX/LaTeX |
koncept.epub |
EPUB av KonCEPT (experimentell) | TeX/LaTeX |
docker-image |
Bygg en Docker image | Docker |
docker-build |
Kör Docker image i en container | Docker |
TeX är ett typsättningssystem där ett dokument, en bok eller en artikel
kan beskrivas i ren text (filer med filändelsen .tex) för att sedan
med hjälp av programvara generera texten för att få formatering. För att
generera PDF-filer av vår kod behövs TeX och vissa extra komponenter
installeras.
Linux/Debian
sudo apt update
sudo apt install texlive texlive-extra-utils texlive-lang-european texlive-science texlive-fonts-recommended texlive-fonts-extra latexmk