Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/Book/3.9"
| Line 15: | Line 15: | ||
It will be replaced by a more prominent location soon. | It will be replaced by a more prominent location soon. | ||
| − | == | + | == Contributing == |
| + | |||
| + | === Steps for contributing === | ||
| + | |||
| + | To be able to contribute to the Scout book, please | ||
| + | |||
| + | * create a github account by | ||
| + | ** browsing to "github.com" | ||
| + | ** signing up (you may sign up for a free account) (samuelrenold) | ||
| + | * install git on your local computer by | ||
| + | ** downloading the latest version of git | ||
| + | ** installing git using the standard options in all installation steps | ||
| + | * clone the github account of matthiaszimmermann by | ||
| + | ** opening the Git Gui and using the link ''clone project archive'' | ||
| + | ** entering [https://github.com/matthiaszimmermann/scoutbook the github repository] into the textfield ''origin'' | ||
| + | |||
| + | === Steps for building the book locally === | ||
This section holds the necessary installation/setup that is required to build the book out of the sources. | This section holds the necessary installation/setup that is required to build the book out of the sources. | ||
| + | |||
| + | Most probably, you may want to build the book on your own computer to check your contribution prior to publish them. If so, you need to download and install | ||
* latex (for PDF and HTML version) | * latex (for PDF and HTML version) | ||
| Line 28: | Line 46: | ||
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. | 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: | + | Building the book is done using ''make'' in the main folder of your local book repository (make sure to edit the makefile in the root path of the git repository to account for the installation paths of the downloaded software): |
make clean | make clean | ||
| Line 43: | Line 61: | ||
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 | 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 | ||
| − | === | + | === Installing the software === |
| − | + | ==== Windows ==== | |
| − | * | + | For Windows, please follow the steps indicated below: |
| − | * | + | * Download and install LaTeX |
| + | ** visit [http://miktex.org/download (basic-miktex-2.9.4521-x64)] | ||
| + | ** download the installer file | ||
| + | ** execute the installer file and take note of the installation path (you will later need to adapt the makefile) | ||
| − | * Calibre | + | * Download and install Calibre |
| − | * | + | ** visit [http://calibre-ebook.com/download_windows (calibre version 0.9.5)] |
| + | ** download the installer file | ||
| + | ** execute the installer file and take note of the installation path (you will later need to adapt the makefile) | ||
| − | * | + | * Download and install make |
| − | * | + | ** visit [http://www.equation.com/servlet/equation.cmd?fa=make (GNU Make 3.82)] |
| + | ** download the executable and put it into a folder of your preferences | ||
| − | * Zip | + | * Download and install 7-Zip |
| − | * | + | ** visit [http://www.7-zip.org/ (7-Zip)] |
| + | ** download the installer file | ||
| + | ** execute the installer file and take note of the installation path (you will later need to adapt the makefile) | ||
Revision as of 11:29, 8 November 2012
The Scout documentation has been moved to https://eclipsescout.github.io/.
Contents
The Eclipse Scout Book
Some background
Download
- HTML
- EPUB
Repository
The current repository is located at the following github repository. It will be replaced by a more prominent location soon.
Contributing
Steps for contributing
To be able to contribute to the Scout book, please
- create a github account by
- browsing to "github.com"
- signing up (you may sign up for a free account) (samuelrenold)
- install git on your local computer by
- downloading the latest version of git
- installing git using the standard options in all installation steps
- clone the github account of matthiaszimmermann by
- opening the Git Gui and using the link clone project archive
- entering the github repository into the textfield origin
Steps for building the book locally
This section holds the necessary installation/setup that is required to build the book out of the sources.
Most probably, you may want to build the book on your own computer to check your contribution prior to publish them. If so, you need to download and install
- 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 sure to edit the makefile in the root path of the git repository to account for the installation paths of the downloaded software):
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 makefile to the executable files
Installing the software
Windows
For Windows, please follow the steps indicated below:
- Download and install LaTeX
- visit (basic-miktex-2.9.4521-x64)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)
- Download and install Calibre
- visit (calibre version 0.9.5)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)
- Download and install make
- visit (GNU Make 3.82)
- download the executable and put it into a folder of your preferences
- Download and install 7-Zip
- visit (7-Zip)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)