From 5208f742e4e61e8d0717783bcc1f579711534bd3 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 16 Sep 2015 20:54:42 +0200 Subject: [PATCH] Updates readme file. --- README.md | 63 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 18b7093..3b8bfe2 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,37 @@ -Apple Documentation Style - LaTeX Template +Overview ==================================== - -To enable syntax highlighting you need to install Pygments and use xelatex for compilation: - -1. sudo easy_install Pygments -2. xelatex -file-line-error -synctex=1 -shell-escape -interaction=nonstopmode "File.tex" - -To integrate the template with TeXShop: - -1. navigate to ~/Library/TeXShop/Engines -2. open XeLaTeX.engine file -3. add two additional parameters -shell-escape -interaction=nonstopmode - - -Table Of Contents - -![Table Of Contents](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/TOC.png "Table Of Contents") - -Sections, subcection, and subsubsections style - -![Sections, subsections](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Sections.png "Sections, subsections") - -Code listing - -![Code listing](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Codelisting.png "Code listing") - +This LaTeX template will let you create beautiful PDF documents inspired by Apple documentations. - [ ] Title page - [x] Table of contents -- [x] Section, subcectio, and subsubsection style -- [x] Code listing -- [x] Syntax highlighting +- [x] Chapter, section, and subsection headings +- [x] Objective-C code listing with syntax highlighting +- [x] Swift code listing with syntax highlighting + +How To Get Started +==================================== + +1. Install [MacTex](https://www.github.com) + 1. Check if there are any updates for TeXShop and TeX Live Utility applications + 2. Launch TeX Live Utility and update all packages +2. Integrate the template with TeXShop + 1. Navigate to ~/Library/TeXShop/Engines + 2. Open XeLaTeX.engine file + 3. Add two additional parameters -shell-escape -interaction=nonstopmode +3. Install [Pygments](http://pygments.org) + 1. sudo easy_install Pygments + +In case of commandline compilation, use xelatex +``` +xelatex -file-line-error -synctex=1 -shell-escape -interaction=nonstopmode "File.tex" +``` + +Screenshots +==================================== + +![Table Of Contents](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/TOC.png) + +![Sections, subsections](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Sections.png) + +![Objective-C listing](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/CodelistingObjC.png) + +![Swift listing](https://raw.githubusercontent.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/CodelistingSwift.png)