|
|
| (166 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| − | == The Eclipse Scout Book ==
| + | The Scout documentation has been moved to https://eclipsescout.github.io/. |
| − | | + | |
| − | Some background
| + | |
| − | | + | |
| − | == Download ==
| + | |
| − | | + | |
| − | * PDF
| + | |
| − | * HTML
| + | |
| − | * EPUB
| + | |
| − | | + | |
| − | == Repository ==
| + | |
| − | | + | |
| − | The current repository is located at the address given below.
| + | |
| − | | + | |
| − | [https://github.com/matthiaszimmermann/scoutbook github repository for book contents]
| + | |
| − | | + | |
| − | It will be replaced by a more prominent location soon.
| + | |
| − | | + | |
| − | == Setup for Contributing ==
| + | |
| − | | + | |
| − | This section holds the necessary installation/setup that is required to build the book out of the sources.
| + | |
| − | | + | |
| − | * latex (for PDF and HTML version)
| + | |
| − | * calibre (for creation and viewing of EPUB version)
| + | |
| − | * make (for building the book using a make file)
| + | |
| − | * zip/unzip (for packaging of the HTML version into a single zip file)
| + | |
| − | | + | |
| − | For building the book and generating the output files a continuous integration environment will be set up, making it possible to contribute to the Scout book without having a local working latex installation.
| + | |
| − | | + | |
| − | In the sections below, necessary download and installation steps of a working setup are described for Windows (if you have a working setup for Mac or Linux, please consider to amend a corresponding section.
| + | |
| − | | + | |
| − | Building the book is done using ''make'' in the main folder of your local book repository:
| + | |
| − | | + | |
| − | make clean
| + | |
| − | make pdf
| + | |
| − | make html
| + | |
| − | make epub
| + | |
| − | | + | |
| − | The output will then be moved to the following locations
| + | |
| − | | + | |
| − | out\pdf\book.pdf
| + | |
| − | out\html\book.zip (containing the html and other necessary files)
| + | |
| − | out\epub\book.epub
| + | |
| − | | + | |
| − | Depending on your installation you will need to update the paths in your [https://github.com/matthiaszimmermann/scoutbook/blob/master/makefile makefile] to the executable files
| + | |
| − | | + | |
| − | === Windows ===
| + | |
| − | | + | |
| − | Installation directories correspond to paths in makefile
| + | |
| − | | + | |
| − | * Latex download [http://miktex.org/download (basic-miktex-2.9.4521-x64)]
| + | |
| − | * Install directory ''c:\latex\MiKTeX 2.9''
| + | |
| − | | + | |
| − | * Calibre download [http://calibre-ebook.com/download_windows (calibre version 0.9.5)]
| + | |
| − | * Install directory ''C:\latex\Calibre2''
| + | |
| − | | + | |
| − | * Make download [http://www.equation.com/servlet/equation.cmd?fa=make (GNU Make 3.82)]
| + | |
| − | * Install directory ''C:\latex\make''
| + | |
| − | | + | |
| − | * Zip/unzipdownload [http://www.7-zip.org/ (7-Zip)]
| + | |
| − | * Install directory ''c:\Program Files\7-Zip''
| + | |
