Documentation

Tip

This book is writen in asciidoc. You can compile it in HTML using the asciidoctor compiler, see how to install asciidoctor. Then just type make for fast html compiling. You can also preview the document via a browser plugin (firefox, chrome). For the plugin, you have to open the raw file (click RAW button). See for example this README.

Introduction

This book presents student’s intership reports

Contribute to this documentation

1. Create a fork on github of the repository https://github.com/cemosis/book.csmi.eu. (Top right button). It will create a repository in your account

2. Clone your own book.csmi.eu

git clone https://github.com/<username>/book.csmi.eu

1. Edit the book (./docs/*.adoc files) as usual (git add/commit/push).

2. Then create a Pull Request on github from your fork repository to the original one.

see the fork documentation and also how to create a Pull Request documentation

Compiling the book

Installing the toolchain

install ruby and bundle

# On MacOSX
brew install ruby
gem install rake bundle

# on debian/ubuntu
apt-get install ruby-bundler

then run bundle in the top level directory of the book

bundle

Note	it installs all the requirements

then type

bundle exec jekyll serve

Or just make serve

Note	it starts a local web server on the port 4000 where you can read the book.

Reports 2017

Master 1

Roger-Paulin

Chifaa-dahik