From b23a02c92c6d6a7a2c7e35398e4ab6c5ef0f41ff Mon Sep 17 00:00:00 2001
From: Rene Hopf <renehopf@mac.com>
Date: Thu, 3 Dec 2015 06:47:28 +0100
Subject: [PATCH] moved documentation the wiki, readme update

---
 README.md | 59 ++++++-------------------------------------------------
 1 file changed, 6 insertions(+), 53 deletions(-)

diff --git a/README.md b/README.md
index 70f7d7aa..db553552 100644
--- a/README.md
+++ b/README.md
@@ -56,67 +56,20 @@ https://www.youtube.com/watch?v=seEV_i7o1NI
 * sin/cos encoder interpolation
 * Mitsubishi absolute encoders
 * Sanyo Denki absolute encoders
+* Yaskawa absolute encoders
 * Sick HIPERFACE®
+#####Planned:
+* EnDat
+* BiSS
+* SSI
 
 ####TODO
 * AC Async
-* saving parameters to flash
 
 ####Directories
 * hw/eagle/ Eagle board files and schematics
 * hw/spice/ Spice simulation for resolver interface
 * src/ STM32F4 code, command, feedback and control loop
 * stm32f103/ STM32F1 code, running on the HV side, generating PWM
+* bootloader/ bootloader for the f4
 * term/ Terminal with scope and local history. Supports UHU servo and stmbl.
-
-
-####Building the firmware
-##### Requirements
-* gcc-arm-none-eabi-gcc https://launchpad.net/gcc-arm-embedded/+download
-* stlink https://github.com/texane/stlink
-
-##### Flashing
-Add gcc and stlink to your $PATH
-
-    make
-    make burn
-
-####Building Servoterm
-##### Requirements
-* cmake >= 2.8
-* gcc >= 4.8 or clang
-* wxwidgets >= 3.0
-* libserialport http://sigrok.org/wiki/Libserialport
-
-##### Compiling
-
-    cd term/
-    mkdir build/
-    cd build/
-    cmake ../
-    make
-
-####Using Servoterm
-##### Testing HAL
-HAL can be tested without any hardware connected to the STM32F4discovery.
-* Flash STM32F4discovery(STlink and USB OTG must be connected)
-* Launch Servoterm, Click refresh, and connecto to STM32 Virtual ComPort
-
-entering 'list' prints a list of hal pins.
-The current default config is for a 4 pole AC permanent magnet motor with resolver feedback, using an encoder for command. 
-
-> net0.fb <= res0.pos = 0.000000
-
-net0.fb is driven by res0.pos, and its current value is 0. Pins can be connected to other pins, or fixed values.
-
-This example connects the sine wave generatror to wave view 0.
-Offset and gain can be controlled with the sliders below Channel 1(black).
-```
-term0.wave0 = sim0.sin
-sim0.amp = 10
-sim0.freq = 5
-```
-To disconnect a pin, connect it to itself
-```
-term0.wave0 = term0.wave0
-```