Doc: updated Readme.md

README.md

@@ -1,16 +1,28 @@
 # WolfieMouse
-[![Join the chat at https://gitter.im/WolfieMouse/Lobby](https://badges.gitter.im/WolfieMouse/Lobby.svg)](https://gitter.im/WolfieMouse/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-* Trello: <https://trello.com/b/nIOMXuWJ>
+WolfieMouse is a robotics project to build [a micromouse](https://en.wikipedia.org/wiki/Micromouse). This project covers three parts:
 
-This is project for IEEE Region 1 Micromouse competition.
+* Robotics algorithm for maze solving (C++)
+* low-level hardware driver software (C and ARM assembly)
+* Tools to capture and plot robot's sensor data (Python)
+* Embedded hardware design and PCB design (KiCad, an open-source alternative to Altium)
 
-![micromouse](doc/images/micromouse_old.jpg)
+This robot won **The Special Mention Award in 2018 IEEE Region 1 Micromouse Robotics Competition**.
+
+<img src="doc/images/wolfiemouse_2018.jpg" width="270px"><img src="doc/images/wolfiemouse_maze_2018.jpg" width="270px"><img src="doc/images/prize_2018.jpg" width="270px">
 
 ## Get started
 
-If you don't know what is micromouse competition, [this document will help.](doc/What-is-Micromouse.md) 
-Then, if you want to start, see [get stared document](doc/Get-started.md).
+If you don't know what is micromouse competition, [this document will help.](doc/What-is-Micromouse.md).
+
+Requires tools:
+* [GNU Arm Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm) and [Makefile](https://www.gnu.org/software/make/manual/make.html) to build program for the robot.
+* [OpenOCD](http://openocd.org/) to upload the program to the robot and to debug.
+* [KiCad](http://kicad-pcb.org/) to design a PCB hardware.
+
+Otherwise, a [Vagrant](https://www.vagrantup.com/) virtual machine environment is provided to skip installing the above tools.
+
+If you whish to start with this project, see [get stared document](doc/Get-started.md).
 
 ## Documentation
 
@@ -19,17 +31,28 @@ See [documentation section.](doc/)
 ## Directory descriptions
 
 * `doc`: Documentation folder
-* `projects`: Projects folders, including main and test projects
-* `simulation`: another project folder but for algorithm simulation
-* `settings`: Setting files like include path and symbol. Also there is base CubeMX project is located.
-* `source`: Source codes of common libraries
+* `firmware`: The robot's program folder, including robotics algorithms and hardware drivers
+* `simulation`: Programs to test algorithms on a desktop computer
+* `tools`: Contains robot sensor data capturing tools and scripts for Vagrant machine.
 
 ## Gallery
 
-Schematic overview. See the whole schemetic [here (PDF).](doc/hardware_design/schematic_2017_Feb.pdf) 
+Terminal-based simulation program. `M` stands for the position of the robot, `D` stands for the position of the goal in the maze, and `S` stands for the starting position.
+
+![simulation](doc/images/simulation_screen.png)
+
+Schematic overview.
+
+![schematic_overview](doc/images/schematic.png)
+
+PCB Footprint overview.
+
+![pcb_overview](doc/images/pcb_footprint.png)
+
+## License and Credits
 
-![schematic_overview](doc/hardware_design/schematic_2017_Feb-p1.jpg)
+Source code in `firmware` and `simulation` folders are licensed under [GPLv2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html).
 
-PCB Footprint overview. Use [KiCad](http://kicad-pcb.org/) and open `hardware` dicrectory to see footprint.
+External libraries (FreeRTOS, CMSIS, STM32F4 HAL) under `firmware/lib` follow their own terms.
 
-![pcb_overview](doc/hardware_design/Footprint_2017_Feb.jpg)
+The fundamental hardware design is inspired by [Project Futura](http://micromouseusa.com/?page_id=1342) by [Green Ye](http://www.greenye.net/).