Update documentation

This commit is contained in:
Joel Klimont 2022-11-11 17:05:15 +01:00
parent 2dd401da6b
commit b469515f18
12 changed files with 153 additions and 5 deletions

BIN
_images/09_update.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

View file

@ -7,5 +7,6 @@ Erste Schritte
wifi.rst
codeServer.rst
firstProgram.rst
update.rst
secondProgram.rst
thridProgram.rst

View file

@ -0,0 +1,13 @@
Software Updaten
#################
Da wir die ``compLib``, und die andere Software, welche auf dem Roboter läuft, laufend weiterentwickeln, solltet ihr immer wieder euren Roboter auf die neuste Version updaten. Dazu müsst ihr einfach den Roboter mit dem Internet verbinden und dann diesen Befehl in der Kommandozeile des Roboters eingeben:
.. code-block:: bash
sudo apt update && sudo apt upgrade
Am einfachsten kann das über die Webseite gemacht werden, auf der ihr auch euren Code schreibt. Dazu müsst ihr einfach nur das Terminal (= Konsole) öffnen, dann den Befehl dort hineinkopieren und Enter drücken.
|updatePic|
.. |updatePic| image:: images/09_update.png

View file

@ -49,6 +49,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="thridProgram.html">Mein drittes Programm</a></li>
</ul>

View file

@ -21,7 +21,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="next" title="Mein zweites Programm" href="secondProgram.html" />
<link rel="next" title="Software Updaten" href="update.html" />
<link rel="prev" title="Programmierumgebung" href="codeServer.html" />
</head>
@ -46,6 +46,7 @@
<li class="toctree-l2"><a class="reference internal" href="wifi.html">WLAN-Verbindung herstellen</a></li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="thridProgram.html">Mein drittes Programm</a></li>
</ul>
@ -104,7 +105,7 @@ Im nächsten Schritt erstellen wir unsere Datei <code class="docutils literal no
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="codeServer.html" class="btn btn-neutral float-left" title="Programmierumgebung" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="secondProgram.html" class="btn btn-neutral float-right" title="Mein zweites Programm" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="update.html" class="btn btn-neutral float-right" title="Software Updaten" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View file

@ -46,6 +46,7 @@
<li class="toctree-l2"><a class="reference internal" href="wifi.html">WLAN-Verbindung herstellen</a></li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="thridProgram.html">Mein drittes Programm</a></li>
</ul>
@ -97,6 +98,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l1"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l1"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a><ul>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html#motoren-ansteuern">Motoren ansteuern</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html#gerade-fahren">Gerade fahren</a><ul>

View file

@ -22,7 +22,7 @@
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="next" title="Mein drittes Programm" href="thridProgram.html" />
<link rel="prev" title="Mein erstes Programm" href="firstProgram.html" />
<link rel="prev" title="Software Updaten" href="update.html" />
</head>
<body class="wy-body-for-nav">
@ -46,6 +46,7 @@
<li class="toctree-l2"><a class="reference internal" href="wifi.html">WLAN-Verbindung herstellen</a></li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Mein zweites Programm</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#motoren-ansteuern">Motoren ansteuern</a></li>
<li class="toctree-l3"><a class="reference internal" href="#gerade-fahren">Gerade fahren</a><ul>
@ -356,7 +357,7 @@ Nun werden wir uns einige weitere Optimierungen und bewährte Verfahren ansehen.
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="firstProgram.html" class="btn btn-neutral float-left" title="Mein erstes Programm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="update.html" class="btn btn-neutral float-left" title="Software Updaten" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="thridProgram.html" class="btn btn-neutral float-right" title="Mein drittes Programm" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

View file

@ -46,6 +46,7 @@
<li class="toctree-l2"><a class="reference internal" href="wifi.html">WLAN-Verbindung herstellen</a></li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Mein drittes Programm</a></li>
</ul>

127
gettingStarted/update.html Normal file
View file

@ -0,0 +1,127 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Software Updaten &mdash; CompLib 0.2.3 Dokumentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/translations.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="next" title="Mein zweites Programm" href="secondProgram.html" />
<link rel="prev" title="Mein erstes Programm" href="firstProgram.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Erste Schritte</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="wifi.html">WLAN-Verbindung herstellen</a></li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="thridProgram.html">Mein drittes Programm</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../software/installation.html">Installationsanweisungen</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/usage.html">Beispiele</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/hardware.html">Hardware</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CompLib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Erste Schritte</a></li>
<li class="breadcrumb-item active">Software Updaten</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/gettingStarted/update.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="software-updaten">
<h1>Software Updaten<a class="headerlink" href="#software-updaten" title="Permalink to this heading"></a></h1>
<p>Da wir die <code class="docutils literal notranslate"><span class="pre">compLib</span></code>, und die andere Software, welche auf dem Roboter läuft, laufend weiterentwickeln, solltet ihr immer wieder euren Roboter auf die neuste Version updaten. Dazu müsst ihr einfach den Roboter mit dem Internet verbinden und dann diesen Befehl in der Kommandozeile des Roboters eingeben:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo apt update <span class="o">&amp;&amp;</span> sudo apt upgrade
</pre></div>
</div>
<p>Am einfachsten kann das über die Webseite gemacht werden, auf der ihr auch euren Code schreibt. Dazu müsst ihr einfach nur das Terminal (= Konsole) öffnen, dann den Befehl dort hineinkopieren und Enter drücken.
<img alt="updatePic" src="../_images/09_update.png" /></p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="firstProgram.html" class="btn btn-neutral float-left" title="Mein erstes Programm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="secondProgram.html" class="btn btn-neutral float-right" title="Mein zweites Programm" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
</div>
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View file

@ -52,6 +52,7 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="codeServer.html">Programmierumgebung</a></li>
<li class="toctree-l2"><a class="reference internal" href="firstProgram.html">Mein erstes Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Software Updaten</a></li>
<li class="toctree-l2"><a class="reference internal" href="secondProgram.html">Mein zweites Programm</a></li>
<li class="toctree-l2"><a class="reference internal" href="thridProgram.html">Mein drittes Programm</a></li>
</ul>

Binary file not shown.

File diff suppressed because one or more lines are too long