From a5ccba0e1cc4d4a84b556e10557eb2e97b3a5cfd Mon Sep 17 00:00:00 2001 From: Thammi Date: Wed, 11 Mar 2015 20:22:39 +0100 Subject: [PATCH] Add install guide --- firmware/Makefile | 4 +-- firmware/doc/install.md | 54 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 firmware/doc/install.md diff --git a/firmware/Makefile b/firmware/Makefile index e47cfcd..986b839 100644 --- a/firmware/Makefile +++ b/firmware/Makefile @@ -1,7 +1,7 @@ -PROJECT=pentabug - APPS = buggy jumpy mariotheme geiger ducklings wuerfel blinker +PROJECT=pentabug + OPTIMIZATION = -Os MCU = atmega88pa F_CPU = 8000000 diff --git a/firmware/doc/install.md b/firmware/doc/install.md new file mode 100644 index 0000000..261bbea --- /dev/null +++ b/firmware/doc/install.md @@ -0,0 +1,54 @@ +# Installation + +Diese Anleitung geht davon aus, dass du ein Ubuntu, Debian oder ein ähnliches +Linux vor dir hast. Es wird grundlegendes Wissen im Umgang mit der Kommandozeile +vorausgesetzt. + +Als erstes müssen die benötigten Programme installiert werden: + + sudo apt-get install avr-libc avrdude gcc-avr build-essential + +Danach kannst du dir den Quellcode für die Firmware des Bugs herunterladen. +Bewege dich dafür in das Verzeichnis in das du den Quellcode kopieren möchtest +und führe folgenden Befehl aus: + + git clone https://github.com/c3d2/pentabug.git + +Jetzt hast du einen neuen Ordner namens `pentabug` in dem sich die Firmware +befindet: + + cd pentabug/firmware/ + +Nun kannst du den menschenlesbaren Quellcode in maschinenlesbare Befehle +überführen. Diesen Vorgang nennt man Kompillieren. Dabei unterstützt dich das +sogenannte `Makefile`, dass automatisch überprüft welche Dateien nicht vorhanden +sind oder geändert wurden + + make + +Wenn der Befehl oben erfolgreich durchgelaufen ist kannst du die Firmware mit +folgendem Befehl auf deinen Pentabug laden: + + make flsmart + +Nun kannst du anfangen den Quellcode anpassen und deine eigenen Programme +entwerfen. Die einzelnen Programme befinden sich im Ordner + + pentabug/firmware/app/ + +Jedes mal wenn du eine Änderung ausprobieren willst musst die wieder das +Makefile ausführen mit folgenden Befehlen + + make + make flsmart + +Wenn du ein neues Programm anlegst oder ein existierendes Programm aus der +Firmware für deinen Pentabug entfernen musst du die erste Zeile folgender Datei +editieren: + + pentabug/firmware/Makefile + +Die einzelnen Einträge hier entsprechen den Dateinamen in + + pentabug/firmware/app/ +