HS-Esslingen/esp-firewall
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Writing documentation

Browse source
This commit is contained in:
Florian Hoss 2022-07-27 08:54:58 +02:00
parent 986b596b46
commit 46b88b6069
6 changed files with 110 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

18
ESPFirewall/lib/Firewall/docs/firststeps/firststeps.tex
View file

@ -12,9 +12,11 @@ A dependency of PlatformIO is Python\footnote{\href{https://www.python.org/}{htt
PlatformIO can now simply installed by downloading a script called ``get-platformio.py'' and executing it. On Apple MacOS\footnote{\href{https://en.wikipedia.org/wiki/MacOS}{https://en.wikipedia.org/wiki/MacOS}} it can simply be installed with the help of Homebrew Packages Manager\footnote{\href{https://brew.sh/}{https://brew.sh/}}.
\subsubsection{Configuration}
It is integrated into Visual Studio Code (Section \ref{sec:vsc}) and can be used with the official Plugin\footnote{\href{https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide}{https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide}} (Abbildung \ref{fig:PlatformIO in VSC}).
The configuration can be initialized with PIO Home or directly written into a \verb|plaftormio.ini| file. Following configuration will be used for simultaneous \verb|esp8266| and \verb|ESP32| usage:
\subsubsection{Example configuration}
The configuration can be initialized with PIO Home or directly written into a \verb|plaftormio.ini| file. Following configuration can be used for simultaneous \verb|esp8266| and \verb|ESP32| usage:
\lstset{style=platform-io}
\begin{lstlisting}
@ -23,7 +25,7 @@ The configuration can be initialized with PIO Home or directly written into a \v
[env:esp32]
platform = espressif32
board = esp32dev
board = az-delivery-devkit-v4
framework = arduino
monitor_speed = 115200
@ -34,7 +36,7 @@ The configuration can be initialized with PIO Home or directly written into a \v
monitor_speed = 115200
\end{lstlisting}
\subsection{IDE}
\subsection{IDE} \label{sec:vsc}
Developing and writing code for this project will be done in Visual Studio Code\footnote{\href{https://code.visualstudio.com/}{https://code.visualstudio.com/}}.
@ -42,6 +44,14 @@ Developing and writing code for this project will be done in Visual Studio Code\
\cite[][]{vscode-about}
\begin{figure}[H]
\begin{center}
\includegraphics[width=0.3\textwidth]{pio}
\caption{PlatformIO in VSC}
\label{fig:PlatformIO in VSC}
\end{center}
\end{figure}
\subsection{Documentation}
Documentation is written in \LaTeX and will be added to the library as source-code only.