diff --git a/README.md b/README.md index 5db9bc8..be28588 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ # STM32GENERIC -Generic implementation of Arduino for STM32 boards +Generic implementation of Arduino for STM32 boards using STM32 HAL. This is an alternative to the [Official implementation](https://github.com/stm32duino/Arduino_Core_STM32) Documentation: https://danieleff.github.io/STM32GENERIC/ + +## Installation - Users + +TODO create boards manager package + +## Installation - Developers + +1. Download the latest version from [https://github.com/danieleff/STM32GENERIC](https://github.com/danieleff/STM32GENERIC) +2. Unzip it into [Arduino]/hardware folder +3. Install Arduino Zero from the board manager for the arm-none-eabi-gcc compiler + +Additional instructions for F7 boards: + +1. Download the [latest GNU ARM Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads) +2. Change compiler.path in [platform.txt](https://github.com/danieleff/STM32GENERIC/blob/master/STM32/platform.txt#L21) to point to that you downloaded. diff --git a/docs/index.html b/docs/index.html index 058026e..86db1f7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -225,6 +225,11 @@
  • Unzip it into [Arduino]/hardware folder
  • Install Arduino Zero from the board manager for the arm-none-eabi-gcc compiler
    • +

    Additional instructions for F7 boards:

    +
      +
    1. Download the latest GNU ARM Embedded Toolchain
      2. +
    2. Change compiler.path in platform.txt to point to that you downloaded.
      3. +

    Uploading

    Please go to the Uploading page.

    List of boards

    diff --git a/docs/mkdocs/search_index.json b/docs/mkdocs/search_index.json index 6cb967e..5fa3c7d 100644 --- a/docs/mkdocs/search_index.json +++ b/docs/mkdocs/search_index.json @@ -2,7 +2,7 @@ "docs": [ { "location": "/", - "text": "STM32GENERIC\n\n\nA generic \nArduino\n implementation for \nSTM32 boards\n.\n\n\nInstallation - Users\n\n\nTODO create boards manager package\n\n\nInstallation - Developers\n\n\n\n\nDownload the latest version from \nhttps://github.com/danieleff/STM32GENERIC\n\n\nUnzip it into [Arduino]/hardware folder\n\n\nInstall Arduino Zero from the board manager for the arm-none-eabi-gcc compiler\n\n\n\n\nUploading\n\n\nPlease go to the \nUploading\n page.\n\n\nList of boards\n\n\nPlease go to the \nBoards\n page.\n\n\nAPI documentation\n\n\nPlease go to the \nArduino API implementation\n page.", + "text": "STM32GENERIC\n\n\nA generic \nArduino\n implementation for \nSTM32 boards\n.\n\n\nInstallation - Users\n\n\nTODO create boards manager package\n\n\nInstallation - Developers\n\n\n\n\nDownload the latest version from \nhttps://github.com/danieleff/STM32GENERIC\n\n\nUnzip it into [Arduino]/hardware folder\n\n\nInstall Arduino Zero from the board manager for the arm-none-eabi-gcc compiler\n\n\n\n\nAdditional instructions for F7 boards:\n\n\n\n\nDownload the \nlatest GNU ARM Embedded Toolchain\n\n\nChange compiler.path in \nplatform.txt\n to point to that you downloaded.\n\n\n\n\nUploading\n\n\nPlease go to the \nUploading\n page.\n\n\nList of boards\n\n\nPlease go to the \nBoards\n page.\n\n\nAPI documentation\n\n\nPlease go to the \nArduino API implementation\n page.", "title": "Installation" }, { @@ -17,7 +17,7 @@ }, { "location": "/#installation-developers", - "text": "Download the latest version from https://github.com/danieleff/STM32GENERIC Unzip it into [Arduino]/hardware folder Install Arduino Zero from the board manager for the arm-none-eabi-gcc compiler", + "text": "Download the latest version from https://github.com/danieleff/STM32GENERIC Unzip it into [Arduino]/hardware folder Install Arduino Zero from the board manager for the arm-none-eabi-gcc compiler Additional instructions for F7 boards: Download the latest GNU ARM Embedded Toolchain Change compiler.path in platform.txt to point to that you downloaded.", "title": "Installation - Developers" }, { diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 4b7cae4..39cf08d 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -4,7 +4,7 @@ / - 2017-06-15 + 2017-07-05 daily @@ -12,7 +12,7 @@ /upload/ - 2017-06-15 + 2017-07-05 daily @@ -21,61 +21,61 @@ /menu_options/ - 2017-06-15 + 2017-07-05 daily /arduino_api/ - 2017-06-15 + 2017-07-05 daily /spi/ - 2017-06-15 + 2017-07-05 daily /i2c/ - 2017-06-15 + 2017-07-05 daily /i2s/ - 2017-06-15 + 2017-07-05 daily /sdio/ - 2017-06-15 + 2017-07-05 daily /uart/ - 2017-06-15 + 2017-07-05 daily /usb_cdc/ - 2017-06-15 + 2017-07-05 daily /usb_msc/ - 2017-06-15 + 2017-07-05 daily /stm32_hal/ - 2017-06-15 + 2017-07-05 daily @@ -84,7 +84,7 @@ /libraries/ - 2017-06-15 + 2017-07-05 daily @@ -93,19 +93,19 @@ /boards/ - 2017-06-15 + 2017-07-05 daily /add_board/ - 2017-06-15 + 2017-07-05 daily /test/ - 2017-06-15 + 2017-07-05 daily @@ -114,7 +114,7 @@ /about/ - 2017-06-15 + 2017-07-05 daily diff --git a/tools/documentation/mkdocs/index.md b/tools/documentation/mkdocs/index.md index 555c919..c64cac7 100644 --- a/tools/documentation/mkdocs/index.md +++ b/tools/documentation/mkdocs/index.md @@ -12,6 +12,10 @@ TODO create boards manager package 2. Unzip it into [Arduino]/hardware folder 3. Install Arduino Zero from the board manager for the arm-none-eabi-gcc compiler +Additional instructions for F7 boards: + +1. Download the [latest GNU ARM Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads) +2. Change compiler.path in [platform.txt](https://github.com/danieleff/STM32GENERIC/blob/master/STM32/platform.txt#L21) to point to that you downloaded. ## Uploading