diff --git a/README.md b/README.md index fb56876d..02ac0dd0 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ logo +LEADS is a lightweight embedded assisted driving system. It is designed to simplify the development of the instrumentation system for electric vehicles. It is written in well-organized Python and C/C++ with impressive performance. It is not only plug-and-play ([VeC Project](https://www.villanovacollege.org/giving/vec-project)) but also fully customizable. It provides multiple abstract layers that allow users to pull out the components and rearrange them into a new project. You can either configure the existing executable module `leads_vec` and `leads_vec_rc` simply through a JSON file or write your own codes based on the framework as easily as building a LEGO. + LEADS only supports two drive-wheel configurations: single rear wheel (SRW) mode and dual rear wheel (DRW) mode. -This project aims to implement the following features: +## Key Features - [x] A basic instrumentation system - [x] A basic communication system @@ -20,6 +22,8 @@ This project aims to implement the following features: - [ ] EBI (Emergency Braking Intervention) - [ ] ATBS (Automatic Trail Braking System) +## To High School Students + The codes are never designed for average high school students to understand. You may find it hard to read the codes if you do not satisfy the following requirements of skills and knowledge.