Skip to content

W
White Rabbit Starting Kit
Commit f6c9031f authored by manuel's avatar manuel
Browse files
Options

Merge branch 'develop' of https://bitbucket.org/sevensols/wr-starting-kit into… 

Merge branch 'develop' of https://bitbucket.org/sevensols/wr-starting-kit into manu-191025_update_Dockerfiles
parents dcaec763 15db357c
Hide whitespace changes
Inline Side-by-side
Showing with 102 additions and 77 deletions
doc/Makefile
View file @ f6c9031f
......@@ -23,8 +23,8 @@ PDF=$(addprefix pdf/, $(SRC:.md=.pdf))
TEX=$(SRC:.md=.tex)
## Pandoc arguments
OPTIONS=-f markdown --toc --number-sections --smart
TEMPLATE=pandoc.latex
OPTIONS=-s --from markdown+yaml_metadata_block --toc --number-sections --smart
TEMPLATE=pandoc.latex
ifneq "$(TEMPLATE)" ""
......@@ -47,6 +47,11 @@ pdf: $(PDF)
DIR_%:
mkdir -p $(subst DIR_,,$@)
pdf/wr-starting-kit.pdf: wr-starting-kit.md Makefile $(TEMPLATE) DIR_pdf
pandoc $(OPTIONS) --latex-engine=xelatex --listings --highlight-style=haddock $(TEMPLATEARG) \
-V title="WR Starting Kit" -V subtitle="User Guide" -V author="Seven Solutions" \
-V lang=english -V fontsize=11pt -V documentclass=article -V bg-color=238,245,240 -V date="$(DATE) - $(VERSION)" -o $@ $<
pdf/%.pdf: %.md Makefile $(TEMPLATE) DIR_pdf
pandoc $(OPTIONS) --latex-engine=xelatex --listings --highlight-style=haddock $(TEMPLATEARG) \
-V lang=english -V fontsize=11pt -V documentclass=article -V bg-color=238,245,240 -V date="$(DATE) - $(VERSION)" -o $@ $<
......
doc/README.md
View file @ f6c9031f
---
title: 'Generate WR Starting Kit Documentation'
subtitle: "How to generate starting kit pdf from markdown using pandoc"
author: Seven Solutions
...
Intro
==========
......
doc/pandoc.latex
View file @ f6c9031f
......@@ -106,7 +106,7 @@ $if(listings)$
keywords={sudo},
alsoletter={\#,:,>},%
emph={>:\# ,>:$$},
moreemph={wrc\# ,wrc1\# ,wrc2\# ,root@wrztp,\/\#},
moreemph={wrc\# ,wrc1\# ,wrc2\# , >spusa:\$$ ,>tornado:\$$,>spusa:\# ,>tornado:\# },
emphstyle=\color{darkred},
comment=[l]{\#\#},%
morestring=[s]{\{}{\}},
......@@ -351,7 +351,7 @@ $endif$
%% Footer
\renewcommand{\footrulewidth}{1pt}
\fancyfoot[L]{{\scriptsize \bfseries $title$ - $title-prefix$} \\ \raisebox{5pt}{\tiny $date$}}
\fancyfoot[L]{{\scriptsize \bfseries $title$ - $subtitle$} \\ \raisebox{5pt}{\tiny $date$}}
\fancyfoot[C]{\raisebox{0pt}{\small \weburl }}
\fancyfoot[R]{\raisebox{0pt}{\scriptsize \thepage}}
......@@ -405,31 +405,26 @@ $endif$
\makeatletter
\def\thickhrulefill{\leavevmode \leaders \hrule height 1pt\hfill \kern \z@}
\renewcommand{\maketitle}{\begin{titlepage}%
$if(imgcover)$
\ThisLRCornerWallPaper{1}{$imgcover$}
$endif$
\vspace{5mm}
\begin{minipage}{\textwidth}
\vspace{4.5cm}
\begin{flushright}
\fontsize{10pt}{8pt}\selectfont
{\@date}
\end{flushright}
\end{minipage}
\begin{minipage}{\textwidth}
\vspace{5.8cm}
\noindent
\begin{center}
\textsc{\textbf{\@title}}
\end{center}
\vspace{7cm}
\begin{flushleft}
{\Large \textbf{\@author}}\\
\vspace{2cm}
{\large \OldTexttt{Seven Solutions S.L}}\\
{\url{www.sevensols.com}}
\end{flushleft}
\end{minipage}
\let\footnotesize\small
\let\footnoterule\relax
\parindent \z@
\reset@font
\null\vfil
\begin{flushleft}
\Huge \textbf{\@title}
\end{flushleft}
\par
\hrule height 4pt
\par
\begin{flushright}
\large \@date \par
\end{flushright}
\vskip 500\p@
\vfil\null
\begin{flushleft}
\Large \textbf{\@author}
\end{flushleft}
\hrule height 2pt
\end{titlepage}%
\setcounter{footnote}{0}%
}
......
doc/wr-starting-kit.md
View file @ f6c9031f
% WR SPEC Starting Kit
% Benoit RAT, Javier Diaz (Seven Solutions) & Miguel Jimenez (UGR)
\renewcommand{\thesection}{}
### Copyright
Copyright
==============
This document is copyrighted (under the Berne Convention) by Seven
Solutions company and is formally licensed to the public under **GPL v2.0** license.
......@@ -11,7 +10,8 @@ Report content can be copied, modified, and redistributed.
The Seven Solutions Logo can not be modified in any form, or by any means without prior
written permission by Seven Solutions.
### Licenses
Licenses
===============
~~~~~~~
The "WR SPEC Starting Kit" (as defined above) is provided under the terms of GPL v2.0
......@@ -52,7 +52,8 @@ conditions
### Revision table
Revision table
===============
------------------------------------------------------------------------
......@@ -74,8 +75,64 @@ conditions
You can also check the [Changelog section](#changelog) for more information.
Glossary
===========
NIC
: Network Interface Card
DIO
: Digital Input/Output
PTP
: Precise Time Protocol, a time synchronization protocol
EEPROM
: Electrically Erasable Programmable Read-Only Memory, a non-volatile memory
FMC
: FPGA Mezzanine Card, an ANSI standard for mezzanine card form factor.
LEMO
: LEMO is the name of a push-pull connectors made by the LEMO company.
SFP
: Small form-factor pluggable transceiver, a hot-pluggable transceiver for optical fiber
PCIe
: Peripheral Component Interconnect Express, a high-speed serial computer expansion bus standard
LM32
: LatticeMico32 is a 32-bit microprocessor soft core optimized for field-programmable gate arrays (FPGAs).
HDL
: Hardware description language
SPEC
: Simple PCIe FMC carrier
UART
: Universal Asynchronous Receiver/Transmitter
WB
: Whishbone Bus, an open system bus interconnect architecture designed for reuse
WRC / WRPC
: White Rabbit (PTP) Core, the main funcionality shared by all WR elements.
WR
: White Rabbit
WRS
: White Rabbit Switch
\clearpage
\renewcommand{\thesection}{\oldthesection}
\setcounter{section}{0}
Introduction
=============
......@@ -221,10 +278,8 @@ experiments you will need:
* The Operative System **Ubuntu LTS 64bit (Long Term Support)** installed.
* Two mini-USB (B) cables (not provided with the kit).
This tutorial has been tested and verified with Ubuntu LTS 12.04 and Ubuntu LTS 14.04,
this mean that standard support will only be given for these releases.
However, the `spec-sw` driver should work with other releases, distributions and architectu
that run kernel `2.8.x` to `3.5.x`.
This tutorial has been tested and verified with Ubuntu LTS 16.04.6 (kernel v.4.15.9) and Ubuntu LTS 18.04.2 (kernel v.4.18.0-17), this mean that standard support will only be given for these releases.
However, the `spec-sw` driver should work with other releases, distributions and architectures.
![Configuration with one two PCs](img/ssk_configs.png)
......@@ -1684,43 +1739,6 @@ Please help us to solve this error by sending us a log with the following inform
* The serial log starting from the login (dmesg)
Glossary
===========
NIC
: Network Interface Card
DIO
: Digital Input/Output
PTP
: Precise Time Protocol, a time synchronization protocol
EEPROM
: Electrically Erasable Programmable Read-Only Memory, a non-volatile memory
FMC
: FPGA Mezzanine Card, an ANSI standard for mezzanine card form factor.
LEMO
: LEMO is the name of a push-pull connectors made by the LEMO company.
SFP
: Small form-factor pluggable transceiver, a hot-pluggable transceiver for optical fiber
PCIe
: Peripheral Component Interconnect Express, a high-speed serial computer expansion bus standard
LM32
: LatticeMico32 is a 32-bit microprocessor soft core optimized for field-programmable gate arrays (FPGAs).
HDL
: Hardware description language
SPEC
: Simple PCIe FMC carrier
UART
: Universal Asynchronous Receiver/Transmitter
WB
: Whishbone Bus, an open system bus interconnect architecture designed for reuse
WRC / WRPC
: White Rabbit (PTP) Core, the main funcionality shared by all WR elements.
[WR]
: White Rabbit
[WRS]
: White Rabbit Switch
[WR]:https://www.ohwr.org/project/white-rabbit/wikis/home
[WRS]: https://sevensols.com/index.php/products/white-rabbit-switch/
[WRSSK]: http://www.sevensols.com/en/products/wr-starting-kit.html
......@@ -1769,4 +1787,4 @@ References
[wr_external_reference.pdf]: http://www.ohwr.org/attachments/1647/wr_external_reference.pdf
[wrpc.pdf]: http://www.ohwr.org/attachments/2559/wrpc-v2.1.pdf
[wrpc-v2.1.pdf]: http://www.ohwr.org/attachments/2559/wrpc-v2.1.pdf
[Seven Solutions]: http://www.sevensols.com
\ No newline at end of file
[Seven Solutions]: http://www.sevensols.com
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment