From cf4cd2813b09bd8d4ae5015751c68072589ccb26 Mon Sep 17 00:00:00 2001 From: Andrew Lalis Date: Fri, 2 Dec 2022 11:54:18 +0100 Subject: [PATCH] Added more info to readme. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index cdfc019..f89e940 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # GymPal A simple device for recording gym sessions, using AVR. +The GymPal is a lightweight piece of hardware with built-in storage, time-keeping, display, and controls, to allow you to record exercise metrics on-the-fly in a satisfying, tactile way. + ## Development The software for this system is developed in C, using [avr-libc](https://www.nongnu.org/avr-libc/), and the build toolchain is managed by make, using [avr-gcc](https://linux.die.net/man/1/avr-gcc) and [avr-dude](https://github.com/avrdudes/avrdude) to upload firmware to the Atmega328p microcontroller. @@ -8,6 +10,13 @@ To compile the firmware, you can run `make`. To upload the firmware to an Arduino, run `make flash`. +## Hardware +Here's a list of the hardware that this project uses, just for reference: +- Microprocessor: [Atmega328p](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-7810-Automotive-Microcontrollers-ATmega328P_Datasheet.pdf) +- Real-Time-Clock: [DS3231SN](https://nl.mouser.com/datasheet/2/256/DS3231-1513891.pdf) +- Display (subject to change): [SSD1306 OLED 128x64](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf) +- Onboard storage: [Adafruit SD Card Module](https://cdn-shop.adafruit.com/datasheets/TS16GUSDHC6.pdf) + ### Helpful Links The following links are helpful for learning how to program an AVR-based microcontroller.