From c18293bda31140945271a8916f3c02e4f7e24b0d Mon Sep 17 00:00:00 2001 From: Chris Hinze Date: Mon, 12 Oct 2015 12:54:43 +0200 Subject: [PATCH 1/2] improved readme --- README.md | 55 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3490332..1856b95 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,36 @@ -#Nur idioten benutzen die SampleCheatsheets! Sie sind zur Übersicht und entsprechen mitunter nicht dam aktuelle Stand!\n +# Nur idioten benutzen die SampleCheatsheets! Sie sind zur Übersicht und entsprechen mitunter nicht dam aktuelle Stand! + +# Richtige Benutzung: + +## Repository kopieren + + $ git clone https://github.com/FAUSheppy/Uni_Latex + $ cd Uni_Latex + +## Repository updaten + + $ git pull + +## PDF bauen + +Vor dem Bauen das Repository updaten. + + $ make + +# Die Makefiles +`make/make all` -> Standard +`make continous` -> compeliert immer neu wenn sich etwas geändert hat +`make clean` (nur ThProg) -> löscht alle Builddateien und PDFs und compeliert neu +`make cleanup` (nur ThProg) -> Löscht alle Build-Dateien aber nicht die PDFs +`make single` (nur ThProg) -> Kompeliert die PDFs und fügt sie zu einem einzelnen zusammen + +Das Makefile in ThProg läuft außerdem ultra-quite in nicht-continous modes. Beachtet das wenn ihr zum debuggen nicht 'make continous' verwendet. + + +# Ich habe einen Fehler gefunden! +-> macht eine Issue auf +-> schreibt mir im IRC (Sheppy) +-> macht einen Pullrequest (bestes) -#Richtige Benutzung:\n -'git clone https://github.com/FAUSheppy/Uni_Latex'\n -'git pull' (innerhalbt des Ordners der durch Git-Clone entstanden ist) \n -...um das Repro zu updaten (was ihr machen solltet bevor ihr die Makefiles verwendet!)\n -\n -#Die Makefiles: -\n make/make all -> Standard -\n make continous -> compeliert immer neu wenn sich etwas geändert hat -\n make clean (nur ThProg) -> löscht alle Builddateien und PDFs und compeliert neu -\n make cleanup (nur ThProg) -> Löscht alle Build-Dateien aber nicht die PDFs -\n make single (nur ThProg) -> Kompeliert die PDFs und fügt sie zu einem einzelnen zusammen -\n -\n Das Makefile in ThProg läuft außerdem ultra-quite in nicht-continous modes. Beachtet das wenn ihr zum debuggen nicht 'make continous' verwendet. -\n \n -#Ich habe einen Fehler gefunden! -\n-> macht eine Issue auf -\n-> schreibt mir im IRC (Sheppy) -\n-> macht einen Pullrequest (bestes) -\n\n Schreibzugriff auf dieses Repro haben außerdem nudelsalat und greeny. -\n + From 2511d7e4e17e71b43e13bd19034b4bfd5267a48f Mon Sep 17 00:00:00 2001 From: Chris Hinze Date: Mon, 12 Oct 2015 12:55:28 +0200 Subject: [PATCH 2/2] improved readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1856b95..645af0e 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,19 @@ Vor dem Bauen das Repository updaten. $ make # Die Makefiles -`make/make all` -> Standard -`make continous` -> compeliert immer neu wenn sich etwas geändert hat -`make clean` (nur ThProg) -> löscht alle Builddateien und PDFs und compeliert neu -`make cleanup` (nur ThProg) -> Löscht alle Build-Dateien aber nicht die PDFs -`make single` (nur ThProg) -> Kompeliert die PDFs und fügt sie zu einem einzelnen zusammen +* `make/make all` -> Standard +* `make continous` -> compeliert immer neu wenn sich etwas geändert hat +* `make clean` (nur ThProg) -> löscht alle Builddateien und PDFs und compeliert neu +* `make cleanup` (nur ThProg) -> Löscht alle Build-Dateien aber nicht die PDFs +* `make single` (nur ThProg) -> Kompeliert die PDFs und fügt sie zu einem einzelnen zusammen Das Makefile in ThProg läuft außerdem ultra-quite in nicht-continous modes. Beachtet das wenn ihr zum debuggen nicht 'make continous' verwendet. # Ich habe einen Fehler gefunden! --> macht eine Issue auf --> schreibt mir im IRC (Sheppy) --> macht einen Pullrequest (bestes) +* macht eine Issue auf +* schreibt mir im IRC (Sheppy) +* macht einen Pullrequest (bestes) Schreibzugriff auf dieses Repro haben außerdem nudelsalat und greeny.