From 9b3d28e0c863032d02e3225713ab9719fd810b4c Mon Sep 17 00:00:00 2001 From: Romain Goyet Date: Thu, 22 Aug 2019 19:14:38 +0200 Subject: [PATCH] [docs] Update the build instructions --- docs/build/index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/build/index.md b/docs/build/index.md index a739e0bc1..35d803888 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -9,20 +9,21 @@ breadcrumb: SDK ### Windows -We recommend using the [Msys2](https://www.msys2.org/) environment to install all the required tools. We support Windows 7 and up. Once Msys2 has been installed, launch the Msys2 terminal application, and enter the following commands +We recommend using the [Msys2](https://www.msys2.org/) environment to install most of the required tools. We support Windows 7 and up. Once Msys2 has been installed, launch the Msys2 terminal application, and enter the following commands ``` -pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-fltk git make bison python +pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-fltk git make python export PATH=/mingw64/bin:$PATH ``` +Last but not least, download and install the latest [GCC toolchain from ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). + ### macOS -We recommend using [Homebrew](https://brew.sh) to install most dependencies. Once you have installed Homebrew, install all the dependencies with the following command: +We recommend using [Homebrew](https://brew.sh) to install all dependencies. Once you have installed Homebrew, install all the dependencies with the following command: ``` -brew reinstall fltk freetype dfu-util libpng pkg-config -brew cask reinstall gcc-arm-embedded +brew install armmbed/formulae/arm-none-eabi-gcc fltk freetype dfu-util libpng pkg-config ``` ### Debian or Ubuntu @@ -30,9 +31,11 @@ brew cask reinstall gcc-arm-embedded Installing the required tools is just a command away: ``` -apt-get install bison build-essential dfu-util flex gcc-arm-none-eabi git libfltk1.3-dev libfreetype6-dev libpng12-dev +apt-get install build-essential dfu-util gcc-arm-none-eabi git libfltk1.3-dev libfreetype6-dev libpng12-dev ``` +Note that you may want to use the latest version of [GCC distributed by ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) instead of the one provided by your distribution. In that case you can skip the `gcc-arm-none-eabi` package. + ## Retrieve the source code The code is hosted on GitHub. You can retrieve it using the follwing command. @@ -61,5 +64,4 @@ make make epsilon_flash ``` -## What's next -Congratulations, you've built your first firmware! If you want to dive deeper into the code, you can either read about our design considerations or discover Epsilon's architecture. +Congratulations, you're running your very own version of Epsilon!