From 17f497f357bb48d60b784d11f645dc2f736d28c8 Mon Sep 17 00:00:00 2001
From: Niklas Fauth <niklasfauth@gmx.de>
Date: Mon, 9 Apr 2018 21:52:10 +0200
Subject: [PATCH] ADD: README

---
 .clang-format | 27 ---------------------------
 README.md     | 30 ++++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 27 deletions(-)
 delete mode 100644 .clang-format
 create mode 100644 README.md

diff --git a/.clang-format b/.clang-format
deleted file mode 100644
index e3e7585..0000000
--- a/.clang-format
+++ /dev/null
@@ -1,27 +0,0 @@
----
-BasedOnStyle: LLVM
-AccessModifierOffset: '2'
-AlignAfterOpenBracket: Align
-AlignConsecutiveAssignments: 'true'
-AlignOperands: 'false'
-AlignTrailingComments: 'true'
-SortIncludes: 'false'
-ColumnLimit: '0'
-IndentCaseLabels: 'true'
-IndentWidth: '2'
-KeepEmptyLinesAtTheStartOfBlocks: 'false'
-MaxEmptyLinesToKeep: '2'
-SpaceAfterCStyleCast: 'false'
-SpaceBeforeAssignmentOperators: 'true'
-SpaceBeforeParens: Never
-SpaceInEmptyParentheses: 'false'
-SpacesBeforeTrailingComments: '2'
-SpacesInAngles: 'false'
-SpacesInCStyleCastParentheses: 'false'
-SpacesInContainerLiterals: 'false'
-SpacesInParentheses: 'false'
-SpacesInSquareBrackets: 'false'
-TabWidth: '2'
-UseTab: Never
-
-...
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f7c98b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# New Firmware! Now with actual current sensing!
+This firmware is much better than the old one. tested up to 40A / 60V, no dead board so far :)
+
+## Hoverboard-Board-Hack
+
+This repo contains open source firmware for generic Hoverboard Mainboards.
+The firmware you can find here allows you to use your Hoverboard Hardware (like the Mainboard, Motors and Battery) for cool projects like driving armchairs, person-tracking transportation robots and every other application you can imagine that requires controlling the Motors.
+
+---
+
+#### Hardware
+![otter](https://raw.githubusercontent.com/NiklasFauth/Hoverboard-Board-Hack/master/schema.jpg)
+
+The original Hardware supports two 4-pin cables that originally were connected to the two sensor boards. They break out GND, 12/15V and USART2&3 of the Hoverboard mainboard.
+Both USART2 & 3 can be used for UART and I2C, PA2&3 can be used as 12bit ADCs.
+
+---
+
+#### Flashing
+To build the firmware, just type "make". Make sure you have specified your gcc-arm-none-eabi binary location in the Makefile. Right to the STM32, there is a debugging header with GND, 3V3, SWDIO and SWCLK. Connect these to your SWD programmer, like the ST-Link found on many STM devboards.
+
+Make sure you hold the powerbutton or connect a jumper to the power button pins while flashing the firmware, as the STM might release the power latch and switches itself off during flashing.
+
+---
+
+#### Examples
+
+Have a looh at the config.h in the Inc directory. That's where you configure to firmware to match your project.
+Currently supported: Wii Nunchuck, analog potentiometer and PPM signal from a RC remote.
+If you need additional features like a boost button, have a look at the while(1) loop in the main.c