From 2af9a06f94cd22a656e302bd40a321f266eada56 Mon Sep 17 00:00:00 2001 From: anschrammh Date: Mon, 27 Feb 2023 23:32:52 +0100 Subject: [PATCH] Updated the getting started section of the README.md file --- README.md | 88 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 62 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index d350c62..dac165e 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,6 @@ I am also quite unhappy with the smartwatches that are on the market (expensive, I also wanted to test this W800 SOC more deeply and see what it could do and I think it is a perfect fit for the project. So let's go ! -## Getting started : -### So, you'd like to try this project yourself ? -### Here are the steps to follow, to be able to build the firmware and flash the board : -#### On Windows : -1) Start by cloning the repository. -**Put it in a path that doesn't contain any spaces** ie : C:\Users\Bob\Desktop\projects for example. -2) Once cloning is done, you will need to install the [MSYS2](https://www.msys2.org/) tool/environment. This tool is need to compile the project using **Make**. -3) Open a terminal by clicking on the **MSYS2** icon and execute the following commands to install : - 1) Update packages : - ```bash - pacman -Syu - ``` - 2) Install make : - ```bash - pacman -S msys/make - ``` - 3) Install automake : - ```bash - pacman -S msys/automake - ``` - 5) Install autoconf : - ```bash - pacman -S msys/autoconf - ``` - - ## A Smart Watch project using the Chinese W800 SOC. The W800 is a pretty interesting chip with impressive characteristics for its price (around 1$) : ### Core : @@ -43,6 +17,68 @@ The W800 is a pretty interesting chip with impressive characteristics for its pr * Bluetooth EDR(Classic) and BLE 4.2 * WiFi 2.4Ghz 802.11 b/g/n +## Getting started : +### So, you'd like to try this project yourself ? +### Here are the steps to follow, in order to build the firmware and flash the board : +#### On Windows : +1) Start by cloning this repository. +**Put it in a path that doesn't contain any spaces** ie : "C:\Users\Bob\Desktop\projects" for example. +2) Once cloning is done, you will need to install the [MSYS2](https://www.msys2.org/) tool/environment. This tool is needed to compile the project using **Make**. +3) Open a terminal by clicking on the **MSYS2** icon and execute the following commands to prepare the environment : + 1) Update packages : + ```bash + pacman -Syu + ``` + 2) Install make : + ```bash + pacman -S msys/make + ``` + 3) Install automake : + ```bash + pacman -S msys/automake + ``` + 4) Install autoconf : + ```bash + pacman -S msys/autoconf + ``` + 5) Install gcc : + ```bash + pacman -S msys/gcc + ``` + 6) Install git : + ```bash + pacman -S msys/git + ``` + 7) Install utils needed for menuconfig : + ```bash + pacman -S msys/ncurses-devel + pacman -S msys/gettext-devel + ``` +4) You now, need to download the toolchain required to compile and link the app [here](http://82.157.145.101/download/toolkits/winnermicro/w806/csky-elfabiv2-tools-mingw-minilibc-20210423.tar.gz) and extract it somewhere you remember on your hardrive. +5) Now, go back to the MSYS terminal window and move to the **src/W800_SDK_v1.00.10/** directory which is located in the cloned repository, using the **cd** command. +6) Then, execute the **make menuconfig** command, this should greet you with a crude configuration window. +Move to the **Toolchain Configuration -->** option using the arrows and hit enter. +Using the same controls, move to the **toolchain path** and **set the location** to where you extracted the toolchain in step 4. +7) To be able to flash the board, you will also need to set the used com port in the **Download Configuration --->** option. +**TIPS : set the download rate to : 2000000**, this should speed up the flashing process. +8) Now save your configuration and exit. +9) Finally, type : +```bash +#This will remove all builded object to start from a clean environment (Needed only once) +make distclean + +#This will only compile the library part of the firmware +make lib + +#This will compile the actual firmware using the libraries and produce the .bin file +make + +#This will flash the board using the previously generated .bin file +make down + +#This will do both previous commands in one (build and flash) +make flash +``` ## Sensors : The goal is to embed the following sensors in the watch :