From f2624d1b3244040d9b2698791dccc4724a0ea05f Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Wed, 24 Aug 2022 07:21:35 +0200 Subject: [PATCH] Adding URLs to dependencies, dependency installation procedure for Linux. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 23569aa3..f8e0ab06 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,18 @@ To build and run locally: **Dependencies** -* CMake -* make -* gcc +* [CMake](https://cmake.org/) +* [GCC](https://gcc.gnu.org/) -From the project root: +On (Ubuntu) Linux run: +```bash +sudo apt-get install build-essential cmake ``` + +From the project root: + +```bash cd test && mkdir build && cd build cmake .. make && bin/test-ArduinoCore-API @@ -68,7 +73,7 @@ make && bin/test-ArduinoCore-API In order to compile a core which is implementing ArduinoCore-API you'll need to copy/symlink the `api` directory to the target's `cores/arduino` directory as part of your development and release workflow. The most elegant and effective solution is to develop your core with `api` symlinked and produce the distributable archive by telling `tar` to follow symlinks. Example: -``` +```bash tar --exclude='*.git*' -cjhvf $yourcore-$version.tar.bz2 $yourcore/ ```