forked from Hg/htlle-da-vorlage
Ergänzungen für WSL eingefügt
This commit is contained in:
parent
17d34af18d
commit
8a546dd3a5
52
README.md
52
README.md
@ -20,23 +20,36 @@ Wenn Sie Änderungen an diesem Template wünschen, dann erstellen Sie bitte ein
|
|||||||
|
|
||||||
# Vorbereitung des eigenen Rechners
|
# Vorbereitung des eigenen Rechners
|
||||||
|
|
||||||
Damit die DA gebaut werden kann müssen mehrere Programme installiert sein. Theoretisch funktioniert das auch mit 'purem' Windows, aber einfacher ist es die Arbeit mit Hilfe von Linux zu erstellen. Aus diesem Grund finden Sie hier nur die Anweisungen die sich auf einem **Ubuntu 18.04 LTE** beziehen.
|
Damit die DA gebaut werden kann müssen mehrere Programme installiert sein. Theoretisch funktioniert das auch mit 'purem' Windows, aber einfacher ist es die Arbeit mit Hilfe von Linux zu erstellen. Aus diesem Grund finden Sie hier nur die Anweisungen die sich auf einem **Ubuntu 18.04 LTS** beziehen.
|
||||||
|
|
||||||
## Windows
|
## Windows
|
||||||
|
|
||||||
Wenn man Windows 10 als primäres Betriebssystem verwendet habt man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
Wenn man Windows 10 als primäres Betriebssystem verwendet hat man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
||||||
|
|
||||||
1. Installation einer virtuellen Maschine auf der ein Linux läuft (z.B: mit [HyperV](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v), [VmWare](https://www.vmware.com/at/products/workstation-player.html), [VirtualBox](https://www.virtualbox.org/) oder einem anderen Virtualisierer) -> Dann erhält man eine VM welche man zum bearbeiten der VM extra starten muss
|
### VM installieren
|
||||||
2. Aktivierung des [Windows Subsystem für Linux](https://docs.microsoft.com/en-us/windows/wsl/about) anhand [dieser Anleitung](https://docs.microsoft.com/en-us/windows/wsl/install-win10) welches genau so eine Umgebung erzeugt und bei der diw Windows und Linux Welt miteinenader zusammenwachsen.
|
Installation einer virtuellen Maschine auf der ein Linux läuft (z.B: mit [HyperV](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v), [VmWare](https://www.vmware.com/at/products/workstation-player.html), [VirtualBox](https://www.virtualbox.org/) oder einem anderen Virtualisierer) -> Dann erhält man eine VM welche man zum bearbeiten der VM extra starten muss
|
||||||
|
|
||||||
|
### Windows Subsystem for Linux
|
||||||
|
Aktivierung des [Windows Subsystem für Linux](https://docs.microsoft.com/en-us/windows/wsl/about) anhand [dieser Anleitung](https://docs.microsoft.com/en-us/windows/wsl/install-win10) welches genau so eine Umgebung erzeugt und bei der diw Windows und Linux Welt miteinenader zusammenwachsen.
|
||||||
|
|
||||||
|
Es ist egal für welche der beiden Varianten man sich entscheidet - funktionieren werden technisch gesehen beide gleich gut ... wobei die WSL Variante sicherlich mehr Comfort bietet weil damit [direkt auf das Windows Dateisystem zugegriffen](https://docs.microsoft.com/en-us/windows/wsl/faq#how-do-i-access-my-c-drive) werden kann.
|
||||||
|
|
||||||
|
Das Dateisystem der `C:`-Festplatte von Windows ist im WSL unter folgendem Pfad erreichbar `/mnt/c/`. Die Festplatte `D:` unter dem Pfad `/mnt/d` usw. Es macht also sinn seine Diplomarbeit in unterordner davon anzulegen.
|
||||||
|
|
||||||
|
Damit diese Anleitung für Windows und Linux passt habe ich angenommen dass sie in Windows einen Ordner `c:\Diplomarbeit` haben der mit folgendem Befehl in das WSL home Verzeichnis verlinkt ist:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ln -s /mnt/c/Diplomarbeit ~/Diplomarbeit
|
||||||
|
```
|
||||||
|
|
||||||
Es ist egal für welche der beiden Varianten man sich entscheidet - funktionieren werden technisch gesehen beide gleich gut ... wobei die WSL Variante sicherlich mehr Comfort bietet weil damit direkt auf das Windows Dateisystem zugegriffen werden kann.
|
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
|
|
||||||
Zuerst müssen (einmalig) die notwendigen Pakete in der Linux Umgebung installiert werden. Dieser Vorgang kann einige Zeit in Anspruch nehmen weil ca. 3-4 GB an Daten installiert werden.
|
Zuerst müssen (einmalig) die notwendigen Pakete in der Linux Umgebung installiert werden. Dieser Vorgang kann einige Zeit in Anspruch nehmen weil ca. 3-4 GB an Daten installiert werden.
|
||||||
|
|
||||||
```
|
```
|
||||||
$ sudo apt-get install git build-essential texlive-full pandoc pandoc-citeproc
|
$ sudo apt-get update
|
||||||
|
$ sudo apt-get install git build-essential make make-guile texlive-full pandoc pandoc-citeproc tree
|
||||||
```
|
```
|
||||||
|
|
||||||
# Grundlegende Schritte
|
# Grundlegende Schritte
|
||||||
@ -45,18 +58,30 @@ $ sudo apt-get install git build-essential texlive-full pandoc pandoc-citeproc
|
|||||||
|
|
||||||
Wenn Sie mit einer neuen Diplomarbeit beginnen, dann gehen Sie am besten wie folgt vor:
|
Wenn Sie mit einer neuen Diplomarbeit beginnen, dann gehen Sie am besten wie folgt vor:
|
||||||
|
|
||||||
### Erstellen eines leeren GIT Repositories in dem Sie Ihre DA Daten verwelten werden.
|
### Erstellen eines leeren GIT Repositories in dem Sie Ihre DA Daten verwalten werden.
|
||||||
|
|
||||||
Es ist prinzipiell egal auf welchem GIT Server sie Ihr Repository hosten. Wir empfehlen dies aber auf dem HTL eigenen `https://itsp.htl-leoben.at/git` Server zu machen. **Sollten Sie Ihre Arbeit auf einem anderen Server hosten, dann achten Sie darauf dass sie ein privates Repository verwenden** denn sonst wäre der Inhalt der Arbeit bereits (unabsichtlich) veröffentlicht und beim Plagiatscheck würde Ihre gesamte Arbeit als Plagiat aufscheinen - und damit dann abgelehnt werden.
|
Es ist prinzipiell egal auf welchem GIT Server sie Ihr Repository hosten. Wir empfehlen dies aber auf dem HTL eigenen `https://itsp.htl-leoben.at/git` Server zu machen. **Sollten Sie Ihre Arbeit auf einem anderen Server hosten, dann achten Sie darauf dass sie ein privates Repository verwenden** denn sonst wäre der Inhalt der Arbeit bereits (unabsichtlich) veröffentlicht und beim Plagiatscheck würde Ihre gesamte Arbeit als Plagiat aufscheinen - und damit dann abgelehnt werden.
|
||||||
|
|
||||||
|
|
||||||
|
#### Fall 1: Sie haben bereits ein eigenes DA Repository mit Daten drinnen
|
||||||
|
|
||||||
|
```
|
||||||
|
~/Diplomarbeit$ git clone https://itsp.htl-leoben.at/git/schueler/Diplomarbeit_JAHR.git .
|
||||||
|
```
|
||||||
|
Dieser Befehl klont Ihr bestehendes Repository in das aktuelle verzeichnis.
|
||||||
|
|
||||||
|
#### Fall 2: Sie beginnen mit einem komplett neuen Repository
|
||||||
|
|
||||||
```
|
```
|
||||||
~/Diplomarbeit$ git init
|
~/Diplomarbeit$ git init
|
||||||
|
~/Diplomarbeit$ echo "Meine Diplomarbeit" > README.md
|
||||||
|
~/Diplomarbeit$ git add README.md
|
||||||
~/Diplomarbeit$ git commit -m "first commit"
|
~/Diplomarbeit$ git commit -m "first commit"
|
||||||
~/Diplomarbeit$ git remote add origin https://itsp.htl-leoben.at/git/schueler/Diplomarbeit_JAHR.git
|
~/Diplomarbeit$ git remote add origin https://itsp.htl-leoben.at/git/schueler/Diplomarbeit_JAHR.git
|
||||||
~/Diplomarbeit$ git push -u origin master
|
~/Diplomarbeit$ git push -u origin master
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hinzufügen des Teplates als git-submodul
|
### Hinzufügen des Templates als git-submodul
|
||||||
Danach wird dieses Repository als [git-submodule](https://git-scm.com/docs/git-submodule) dazugeklont:
|
Danach wird dieses Repository als [git-submodule](https://git-scm.com/docs/git-submodule) dazugeklont:
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -231,7 +256,7 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
|
|||||||
## Tipps & Tricks
|
## Tipps & Tricks
|
||||||
|
|
||||||
### Generell
|
### Generell
|
||||||
* Man kan ToDo Blöcke in die DA einfügen indem man folgenden Block verwendet `\todo{Was noch zu tun wäre}`. Diese erscheinen dann als Textblasen am Rand der Arbeit.
|
* Man kann ToDo Blöcke in die DA einfügen indem man folgenden Block verwendet `\todo{Was noch zu tun wäre}`. Diese erscheinen dann als Textblasen am Rand der Arbeit.
|
||||||
|
|
||||||
|
|
||||||
### Versionsverwaltung
|
### Versionsverwaltung
|
||||||
@ -245,12 +270,17 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
|
|||||||
|
|
||||||
* Grammatik + Rechtschreibung beachten (Markdown hat keinen Spell-checker integriert). ggf. `aspell` installieren und durch die Markdown files suchen lassen.
|
* Grammatik + Rechtschreibung beachten (Markdown hat keinen Spell-checker integriert). ggf. `aspell` installieren und durch die Markdown files suchen lassen.
|
||||||
* Irgendwie sollte man ein (einheitliches) Bild vom Leser haben. Negativbeispiel:
|
* Irgendwie sollte man ein (einheitliches) Bild vom Leser haben. Negativbeispiel:
|
||||||
* Einerseits eine Dummy dem man `mdir` erklären muss
|
* Einerseits ein Dummy dem man `mdir` erklären muss
|
||||||
* andererseits kann er Python-Pakete installieren
|
* andererseits kann er Python-Pakete installieren
|
||||||
* Formulierungen
|
* Formulierungen
|
||||||
* keine romanartigen Erzählungen
|
* keine romanartigen Erzählungen
|
||||||
* keine seitenlange Installationsanweisungen (besser: Link auf Anleitung im Web)
|
* keine seitenlange Installationsanweisungen (besser: Link auf Anleitung im Web)
|
||||||
|
* Es sollte einen roten Faden die Diplomarbeit geben. Dazu erklärt man zuerst die Grundlagen und Inhalte die ein gewöhnlicher Leser braucht um sich in Ihrer Arbeit zurchtzufinden (= zumiest Literaturrrecherche). Danach bauen Sie auf diesen Gurndlagen ihren praktischen Teil auf, welche dann zu einem Ergebnis führt. Aus diesem grund ist die DA üblicherweise wie folgt gegliedert:
|
||||||
|
* Aufgabenstellung
|
||||||
|
* Grundlagen
|
||||||
|
* Praktischer Teil
|
||||||
|
* Zusammenfassung
|
||||||
|
* Bei unterschiedlichen Teilaufgabenstellungen (die womöglich aufeinander aufbauen) ist die Reihenfolge der Ausarbeitungen so zu wählen dass der Leser diesen roten Faden nicht verliert ... Grundlagen zuerst !
|
||||||
|
|
||||||
### Quellcode
|
### Quellcode
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user