README updated with docs links

Author: askuric

README.md

@@ -5,95 +5,90 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![arduino-library-badge](https://www.ardu-badge.com/badge/Simple%20FOC.svg?)](https://www.ardu-badge.com/badge/Simple%20FOC.svg)
 
-Proper low cost FOC supporting boards are very hard to find these days and even may not exist. The reason may be that the hobby community has not yet dug into it properly. But even if you would find a hardware which is capable of runing BLDC motors, a good FOC code capable of running on Arduino devices is even harder to find. Therefore this is the attempt to ***demistify the Field Oriented Control (FOC) algorithm*** and make a ***robust but simple implementation*** for ***Arduino hadrware***, as well as to introduce the new [Arduino FOC shield board](https://askuric.github.io/simplefoc.html).
+Proper low-cost and low-power FOC supporting boards are very hard to find these days and even may not exist. Even harder to find is a stable and simple FOC algorithm code capable of running on Arduino devices. 
+Therefore this is an attempt to: 
+- Demistify FOC algorithm and make a robust but simple Arduino library: [Arduino SimpleFOC library](https://askuric.github.io/Arduino-FOC/arduino_simplefoc_library_showcase)
+- Develop a modular BLDCdriver boards: [Arduino SimpleFOC shield](https://askuric.github.io/Arduino-FOC/arduino_simplefoc_shield_showcase).
 
-<p> <img src="extras/Images/shield_top_v13.png" height="200px">   <img src="extras/Images/shield_v13.png" height="200px">
+## Arduino SimpleFOC Shield
+<p> <img src="https://askuric.github.io/Arduino-FOC/extras/Images/shield_top_v13.png" height="300px">   <img src="https://askuric.github.io/Arduino-FOC/extras/Images/shield_v13.png"  height="300px"></p>
 
 ### Features
-- Plug and play capability with the Arduino Simple FOC library
-- Price in the range of \$20-\$40
-- Gerber files and BOM available Open Source
-- Stackable: running at least 2 motors in the same time
+- **Plug & play**: Arduino <span class="simple">Simple<span class="foc">FOC</span>library</span> 
+- **Low-cost**: Price in the range of \$20-\$40
+- **Open Source**: Gerber files and BOM available
+- **Stackable**: running 2 motors in the same time
 
 ##### If you are interested in this board, find more information on this link: [Arduino Simple FOC Shield](https://askuric.github.io/simplefoc.html)
 
-
-## A short library YouTube demonstration video
+## Arduino SimpleFOClibrary
 [![](extras/Images/youtube.png)](https://youtu.be/N_fRYf7Z80k)
 
-This video explains the Simple FOC library basic usage, electronic connections and demonstrates its capabilities.
+This video demonstrates the Simple FOC library basic usage, electronic connections and shows its capabilities.
 
-### This project aims to close the gap in the areas:
-- Low cost applications <50$
-- Low current operation < 5A
-- Simple usage and scalability (Arduino) 
-  - Plug and play arduino library for beginers
-  - Arudino minimal code for easy integration and customisation for different advanced projects
-- Introducing [Arduino FOC shield board](#arduino-simple-foc-shield)  
 
-#### The closest you can get to FOC support and low cost (I was able to find) is:
+### Features
+- **Arduino compatibe**: Arduino library code
+- **Easy to setup and configure**: 
+  - Easy hardware configuration
+  - Easy [tuning the control loops](https://askuric.github.io/Arduino-FOC/control_loops)
+- **Modular**:
+  - Supports as many [sensors ,  BLDC motors  and  driver boards](https://askuric.github.io/Arduino-FOC/electrical_connections) as possible
+  - Supports as many applicaiton requirements as possible
+- **Plug & play**: Arduino SimpleFOC shield
+
+## Getting Started
+Depending on if you want to use this library as the plug and play Arduino library or you want to get insight in the algorithm and make changes there are two ways to install this code.
+
+- Full library installation [Docs](https://askuric.github.io/Arduino-FOC/library_download)
+- Minimal code instalation [Docs](https://askuric.github.io/Arduino-FOC/minimal_download)
+
+### Arduino SimpleFOC library installation to Arduino IDE
+#### Arduino Library Manager 
+The simplest way to get hold of the library is direclty by using Arduino IDE and its integrated Library Manager. 
+- Open Arduino IDE and start Arduino Library Manager by clicking: `Tools > Manage Libraries...`.
+- Serarch for `Simple FOC` library and install the lates version.
+- Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
+
+### Using Github website 
+- Go to the [github repository](https://github.com/askuric/Arduino-FOC)
+- Click first on `Clone or Download > Download ZIP`. 
+- Unzip it and place it in `Arduino Libraries` forlder. Windows: `Documents > Arduino > libraries`.  
+- Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
+
+### Using terminal
+- Open terminal and run
+```sh  
+cd *arduino libraries folder*
+git clone https://github.com/askuric/Arduino-FOC.git
+```
+- Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
+
+###  SimpleFOC library minimal scketch example
+
+For those willing to experiment and to modify the code I suggest using the [minimal version](https://github.com/askuric/Arduino-FOC/tree/minimal) of the code. 
+ > This code is completely indepenedet and you can run it as any other Arduino Schetch without the need for any libraries. 
+
+#### Github webiste downlaod
+- Go to [minimal branch](https://github.com/askuric/Arduino-FOC/tree/minimal) 
+- Downlaod the code by clicking on the `Clone or Download > Download ZIP`.
+- Unzip it and open the schetch in Arduino IDE. 
+
+#### Using terminal
+- Open the terminal:
+  ```sh
+  cd *to you desired directory*
+  git clone -b minimal https://github.com/askuric/Arduino-FOC.git
+  ```
+- Then you just open it with the Arduino IDE and run it.
+
+## Documentation
+Find out more information about the Arduino SimpleFOC project in [docs website](https://askuric.github.io/Arduino-FOC/) 
 
-<a href="https://odriverobotics.com/" >Odroid</a> | <a href="https://www.youtube.com/watch?v=g2BHEdvW9bU">Trinamic</a> | <a href="https://www.infineon.com/cms/en/product/evaluation-boards/bldc_shield_tle9879/" >Infineon</a> | <a href="https://github.com/gouldpa/FOC-Arduino-Brushless">FOC-Arduino-Brushless</a>
------------- | ------------- | ------------ | -------------
-<img src="https://static1.squarespace.com/static/58aff26de4fcb53b5efd2f02/t/5c2c766921c67c143049cbd3/1546417803031/?format=1200w" width="400px"> | <img src="http://i3.ytimg.com/vi/g2BHEdvW9bU/maxresdefault.jpg" width="400px"> | <img src="https://www.infineon.com/export/sites/default/_images/product/evaluation-boards/BLDC_Motor_Shild_with_TLE9879QXA40.jpg_1711722916.jpg" width="400px">| <img src="https://hackster.imgix.net/uploads/attachments/998086/dev_kit_89eygMekks.jpg?auto=compress%2Cformat&w=1280&h=960&fit=max" width="400px">
-:heavy_check_mark: Open Source | :x: Open Source | :x: Open Source | :heavy_check_mark: Open Source
-:heavy_check_mark:Simple to use | :heavy_check_mark: Simple to use | :heavy_check_mark:Simple to use | :x: Simple to use
-:x: Low cost ($100) | :x: Low cost ($100) | :heavy_check_mark:Low cost ($40) | :heavy_check_mark: Low cost
-:x: Low power (>50A) | :heavy_check_mark: Low power  | :heavy_check_mark:  Low power | :heavy_check_mark: Low power
 
 ## Arduino FOC repo structure
 Branch  | Description | Status
 ------------ | ------------- | ------------ 
 [master](https://github.com/askuric/Arduino-FOC) | Stable and tested library version | ![Library Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Compile/badge.svg)
 [dev](https://github.com/askuric/Arduino-FOC/tree/dev) | Developement library version | ![Library Dev Compile](https://github.com/askuric/Arduino-FOC/workflows/Library%20Dev%20Compile/badge.svg?branch=dev)
 [minimal](https://github.com/askuric/Arduino-FOC/tree/minimal) | Minimal Arduino example with integrated library | ![MinimalBuild](https://github.com/askuric/Arduino-FOC/workflows/MinimalBuild/badge.svg?branch=minimal)
-
-
-# Contents
-- [Installation](#arduino-simple-foc-instalation)
-  - [Installing the full Arduino Simple FOC library](#installing-simple-foc-full-library)
-  - [Installing the minimal Arduino example](#download-simple-foc-arduino-minimal-example)
-- [Electrical connecitons and schematic](#electrical-connections)
-  - [Minimal setup](#all-you-need-for-this-project)
-  - [Arduino Simple FOC Shield](#arduino-simple-foc-shield)
-  - [Arduino UNO + L6234 driver](#arduino-uno-l6234-driver)
-  - [HMBGC gimbal contorller example](#hmbgc-v22)
-- [Code explanation and examples](#arduino-simple-foc-library-code)
-  - [Encoder setup](#encoder-setup)
-  - [Magentic sensor setup](#magnetic-sensor-setup)
-  - [BLDC motor setup](#motor-setup)
-  - [Control loop setup](#control-loop-setup)
-    - [Voltage control loop](#voltage-control-loop)
-    - [Velcoity control loop](#velocity-control-loop)
-    - [Angle control loop](#angle-control-loop)
-  - [Debugging practice](#debugging)
-- [Future work and work in progress](#work-roadmap)
-- [Contact](#contact)
-
-
-
-# Work Roadmap
-## Future work
-- [ ] Proper introduction of the **Arudino FOC Shield V1.2**
-- [ ] Publish a video tutorial fir using the library and the samples  
-  - [x] Initial video with simple demonstration
-  - [ ] Coding setup and procedure video
-  - [ ] Two motors running on HMBGC example
-  - [ ] ....
-- [ ] Implement Space Vector Modulation method 
-  -  [ ] Pure SVM
-  -  [ ] PWM SVM
-- [ ] Implement support for MOSFET control low and high pairs
-
-## Work in progress
-- [x] Make the library accesible in the Arduino Library Manager 
-- [x] Make minimal version of the arduino code - all in one arduino file
-- [x] Encoder index proper implementation
-- [x] Enable more dirver types 
-- [x] Make support for magnetic encoder AS5048 ABI
-- [x] Make support for magnetic encoder AS5048 SPI
-- [x] Add support for acceleration ramping
-- [x] Velocity Low pass filter
-- [x] Timer interrupt execution rather than in the `loop()`
-  - FAIL: Perfromance not improved
-- [x] Sine wave lookup table implementation