mirror of https://github.com/speeduino/wiki.js.git
Dynamic header page for PDF
This commit is contained in:
parent
0c36ab02c4
commit
ec2b12ea0f
14
home.md
14
home.md
|
@ -1,3 +1,4 @@
|
|||
|
||||
---
|
||||
title: Speeduino Manual
|
||||
description: The Speeduino documentation manual
|
||||
|
@ -8,11 +9,11 @@ titlepage: true
|
|||
titlepage-rule-height: 2
|
||||
titlepage-rule-color: "360049"
|
||||
titlepage-background: "offline/background1.pdf"
|
||||
logo: "img/Speeduino logo_med.png"
|
||||
logo-width: 120
|
||||
logo: "offline/logo.png"
|
||||
logo-width: 350
|
||||
---
|
||||
|
||||
# Speeduino Manual
|
||||
# Introduction
|
||||
This manual covers the hardware (sensors, wiring etc), software configuration and tuning elements related to running a Speeduino unit. When beginning with Speeduino, particularly if it is your first time installing and configuring an engine management system, this manual will assist in understanding Speeduino's capabilities and how it should be installed, both in terms of hardware and software/firmware.
|
||||
|
||||
Whilst this document will assist in providing information related to Speeduino's configuration, it does not cover advanced engine tuning, fuel / ignition strategies etc. As with any changes to engine management, the possibility of damage to hardware is very real should a system be configured incorrectly.
|
||||
|
@ -20,9 +21,10 @@ Whilst this document will assist in providing information related to Speeduino's
|
|||
### Getting Started
|
||||
|
||||
In terms of starting out with Speeduino, it can help to understand the various compnents that make up the system:
|
||||
1. **A Speeduino board** - This is the muscle of the Speeduino ECU and contains all the drivers and IO circuits. This maybe one of the generic boards (Such as the v0.4) or a PNP board for a specific model car
|
||||
2. **An Arduino** - This is the brains of Speeduino and contains the processor, memory and storage. It plugs into the Speeduino board in order to interface with the vehicle wiring
|
||||
3. **Firmware** - This is the system software that runs on the Arduino board and powers its operation. New firmware is released regularly with updates, performance improvements and bug fixes.
|
||||
|
||||
1. **A Speeduino board** - This is the muscle of the Speeduino ECU and contains all the drivers and IO circuits. This maybe one of the generic boards (Such as the v0.4) or a PNP board for a specific model car
|
||||
2. **An Arduino** - This is the brains of Speeduino and contains the processor, memory and storage. It plugs into the Speeduino board in order to interface with the vehicle wiring
|
||||
3. **Firmware** - This is the system software that runs on the Arduino board and powers its operation. New firmware is released regularly with updates, performance improvements and bug fixes.
|
||||
|
||||
As a starting point, it is generally recommended to first upload the firmware to your Arduino and get it connecting to the tuning software (Tuner Studio) before moving on to hardware assembly or wiring etc. Software setup and configuration on Speeduino can be completed without the need for any additional hardware to be present (Beyond the arduino itself) and this allows exploration of the software and options available before either an outlay of significant funds or a significant investment of time.
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ METADATA_ARG=--metadata-file=${METADATA}
|
|||
ARGS="${TEMPLATE_OPTIONS} --template=${TEMPLATE}"
|
||||
#ARGS="${TEMPLATE_OPTIONS}"
|
||||
#PDF_ARGS="--pdf-engine=xelatex"
|
||||
PDF_ARGS="-f markdown-markdown_in_html_blocks --pdf-engine=xelatex"
|
||||
PDF_ARGS="-f markdown-markdown_in_html_blocks --pdf-engine=xelatex --metadata date=`date +%D`"
|
||||
|
||||
#This contains all the fonts that might be needed
|
||||
#sudo apt-get install texlive-fonts-extra
|
||||
|
@ -43,5 +43,5 @@ cp ${OUTPUT_FILENAME} ${CUR_PATH}/offline
|
|||
|
||||
#Cleanup
|
||||
cd ${BUILD}/..
|
||||
rm -rf ./tmp
|
||||
#rm -rf ./tmp
|
||||
cd ${CUR_PATH}
|
||||
|
|
|
@ -871,6 +871,12 @@ $if(titlepage-background)$
|
|||
\setstretch{2}
|
||||
\vfill
|
||||
\vskip -8em
|
||||
|
||||
$if(logo)$
|
||||
\noindent
|
||||
\includegraphics[width=$if(logo-width)$$logo-width$$else$100$endif$pt, left]{$logo$}
|
||||
$endif$
|
||||
\vskip 2em
|
||||
\noindent {\huge \textbf{\textsf{$title$}}}
|
||||
$if(subtitle)$
|
||||
\vskip 1em
|
||||
|
@ -892,14 +898,13 @@ $else$
|
|||
\vskip 2em
|
||||
\noindent {\Large \textsf{$for(author)$$author$$sep$, $endfor$}}
|
||||
\vfill
|
||||
$if(logo)$
|
||||
\noindent
|
||||
\includegraphics[width=$if(logo-width)$$logo-width$$else$100$endif$pt, left]{$logo$}
|
||||
$endif$
|
||||
}
|
||||
$endif$
|
||||
|
||||
$if(logo)$
|
||||
\noindent
|
||||
\includegraphics[width=$if(logo-width)$$logo-width$$else$100$endif$pt, left]{$logo$}
|
||||
$endif$
|
||||
|
||||
$if(titlepage-background)$
|
||||
$else$
|
||||
\textsf{$date$}
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 164 KiB |
Loading…
Reference in New Issue