From 3d3d74f3817e89a8c3ce2cb36501ad292b6ddc85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Sat, 7 Jul 2018 23:06:16 +0200 Subject: [PATCH] updated readme --- README.md | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b57d000..d369bc0 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,9 @@ GEX core ======== -GEX is a general purpose input/output device that attaches to a PC or laptop. -A GEX board provides direct access to on-chip peripherals and low level drivers in the firmware. - -GEX is designed for quick hardware prototyping, evaluation, and electrical measurements. -The board can be interfaced from C or Python, with plans to support MATLAB and other languages. - -A wireless connection is also planned, likely using ESP8266, SX1276 or NRF24L01+. - -GEX is currently compatible with STM32F072. It will be ported to STM32F103 (bluepill) later, -and there is a good chance of a ESP32 port in the future. - -This repository contains the core of all STM32 ports, while the chip-specific start-up routine, -low level drivers etc. are all in separate projects that include this as a sub-module. - -GEX's F072 port can be run on the F072 Discovery evaluation board. - -Availability ------------- - -GEX is currently in open preview. Please wait with contributing and/or forking until the first stable release. -The core API can be considered stable, but there's no guarantee of this until the 1.0.0 release. Unit driver APIs -may undergo minor changes as they are tested in practical demos and bugs or usability problems are found. +This is the (mostly) independent core of the GEX platform. To port GEX to a new STM32 microcontroller, +add this as a submodule and implement platform specific configuration by following the example of another +existing port. Some examples are in the template folder. License -------