From 521113eba11642e7e12996090b533e6805301eab Mon Sep 17 00:00:00 2001 From: Jonathan Hodgson Date: Fri, 19 Jun 2020 12:29:23 +0100 Subject: [PATCH] Wrap readme at 100 lines and add documentation about auto-downloads --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d02b0d4..ac61162 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is a presentation about Git. To build it, you will need make, pdflatex and ansi-to-svg and inkscape. -To build the main pd, run: +To build the main pdf, run: ```bash make main.pdf @@ -26,7 +26,9 @@ make only-notes.pdf ## Auto Images -The build system will generate certain types of graphics for the presentation as part of the build system. The resultant files will always go in the `auto-images` folder. As a result, this folder is not under version control. +The build system will generate certain types of graphics for the presentation as part of the build +system. The resultant files will always go in the `auto-images` folder. As a result, this folder is +not under version control. In latex, all you need to do is @@ -44,13 +46,16 @@ What is a presentation without an xkcd comic? \includegraphics[]{auto-xkcd-.png} ``` -If the above is included in the latex document, the XKCD comic with the specified ID will be downloaded and embedded in the pdf. +If the above is included in the latex document, the XKCD comic with the specified ID will be +downloaded and embedded in the pdf. ### Shell Output -I am still not aware of aware of a reliable way to include ansi coloured shell output into a latex document. I also don't want to include loads of high-res screenshots in my Git repo. +I am still not aware of aware of a reliable way to include ansi coloured shell output into a latex +document. I also don't want to include loads of high-res screenshots in my Git repo. -The work around I have come up with is to save the raw ansi output to a wile in `shell-output`. This normally involves forcing an application to output in colour: +The work around I have come up with is to save the raw ansi output to a wile in `shell-output`. This +normally involves forcing an application to output in colour: ```bash git -c color.status=always status > shell-output/git-status.out @@ -63,3 +68,14 @@ git -c color.status=always status > shell-output/git-status.out ``` The build system will convert the ansi output into an embeddable PDF that LaTeX will embed. + +### Online images + +In order to download an image from the internet and embed it in the presentation, you need do +provide the extension and the base64 encoded URL. + +```latex +\includegraphics[]{auto-download-.png} +``` + +