Browse Source

updated readme

Ondřej Hruška 1 year ago
parent
commit
3d3d74f381
Signed by: Ondřej Hruška <ondra@ondrovo.com> GPG key ID: 2C5FD5035250423D
1 changed files with 3 additions and 22 deletions
  1. 3 22
      README.md

+ 3 - 22
README.md View File

@@ -1,28 +1,9 @@
1 1
 GEX core
2 2
 ========
3 3
 
4
-GEX is a general purpose input/output device that attaches to a PC or laptop.
5
-A GEX board provides direct access to on-chip peripherals and low level drivers in the firmware.
6
-
7
-GEX is designed for quick hardware prototyping, evaluation, and electrical measurements. 
8
-The board can be interfaced from C or Python, with plans to support MATLAB and other languages.
9
-
10
-A wireless connection is also planned, likely using ESP8266, SX1276 or NRF24L01+.
11
-
12
-GEX is currently compatible with STM32F072. It will be ported to STM32F103 (bluepill) later,
13
-and there is a good chance of a ESP32 port in the future.
14
-
15
-This repository contains the core of all STM32 ports, while the chip-specific start-up routine, 
16
-low level drivers etc. are all in separate projects that include this as a sub-module.
17
-
18
-GEX's F072 port can be run on the F072 Discovery evaluation board.
19
-
20
-Availability
21
-------------
22
-
23
-GEX is currently in open preview. Please wait with contributing and/or forking until the first stable release.
24
-The core API can be considered stable, but there's no guarantee of this until the 1.0.0 release. Unit driver APIs
25
-may undergo minor changes as they are tested in practical demos and bugs or usability problems are found.
4
+This is the (mostly) independent core of the GEX platform. To port GEX to a new STM32 microcontroller,
5
+add this as a submodule and implement platform specific configuration by following the example of another 
6
+existing port. Some examples are in the template folder.
26 7
 
27 8
 License
28 9
 -------