Fix formatting, spelling errors in README.rst

The code blocks added by #17 were formatted as Markdown, but this is an
reStructuredText file. Fix them, and also address a few other small
formatting, spelling, and line length nits.
This commit is contained in:
Thomas Hebb 2020-10-28 23:26:48 -07:00
parent 01d8d7a681
commit 28580b95a1

View File

@ -1,46 +1,47 @@
BLE602 SDK BLE602 SDK
========= ==========
`Discord <https://discord.gg/89VWQVH>`_ , `Telegram <https://t.me/joinchat/Kmi2S0nOsT240emHk-aO6g>`_ `Discord <https://discord.gg/89VWQVH>`_, `Telegram <https://t.me/joinchat/Kmi2S0nOsT240emHk-aO6g>`_
Bouffalolab bl_iot_sdk. Support BL602 Wi-Fi/BLE Combo RISC-V based Chip. Bouffalolab bl_iot_sdk. Support BL602 Wi-Fi/BLE Combo RISC-V based Chip.
Check ``docs/html`` for more detail. Check ``docs/html`` for more detail.
Fire an issue, if you have any issue or need any support. File an issue, if you have any issue or need any support.
Quick Start Quick Start
=========== ===========
In order to build one of the sample apps, you need to set a few environment In order to build one of the sample apps, you need to set a few environment
variables: variables::
```
export BL60X_SDK_PATH=/path/to/this/repo
export CONFIG_CHIP_NAME=bl602
```
Then go to the sample directory of interest and call `make`, for example:
```
cd customer_app/bl602_boot2
make
```
Call
```
make CONFIG_TOOLPREFIX=riscv64-linux-gnu-
```
for bypassing the bundled crosscompiler and using your distribution's own crosscompiler.
export BL60X_SDK_PATH=/path/to/this/repo
export CONFIG_CHIP_NAME=bl602
Then go to the sample directory of interest and call `make`, for example::
cd customer_app/bl602_boot2
make
Call ::
make CONFIG_TOOLPREFIX=riscv64-linux-gnu-
for bypassing the bundled cross-compiler and using your distribution's own
cross-compiler.
There is a linker script (written in python) at `image_conf/flash_build.py`. There is a linker script (written in python) at `image_conf/flash_build.py`.
To run this, you need to specify the application and the target, for example: To run this, you need to specify the application and the target, for example::
```
python3 flash_build.py bl602_boot2 bl602 python3 flash_build.py bl602_boot2 bl602
```
Hardware Hardware
========= =========
BL602 is a 32-bit RISC-V based combo chipset supporting Wi-Fi and BLE (Bluetooth Low Energy). The chip is made by `Nanjing-based Bouffalo Lab <https://www.bouffalolab.com/bl602>`_ for ultra-low-power applications. BL602 is a 32-bit RISC-V based combo chipset supporting Wi-Fi and BLE (Bluetooth
In terms of price range and feature set, the chip is competing against `Espressif ESP8266 <https://www.espressif.com/en/products/socs/esp8266>`_ Low Energy). The chip is made by `Nanjing-based Bouffalo Lab <https://www.bouffalolab.com/bl602>`_
for ultra-low-power applications. In terms of price range and feature set, the
chip is competing against `Espressif ESP8266 <https://www.espressif.com/en/products/socs/esp8266>`_
Comparison with ESP8266 Comparison with ESP8266
======================= =======================