From 52b0113522779485ea3b33de20c02f4a9294e7ea Mon Sep 17 00:00:00 2001 From: JRT Date: Sun, 27 Jun 2021 00:02:41 +0200 Subject: [PATCH 1/2] Add update instructions to the Readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index d9fc720..1454e6c 100644 --- a/README.md +++ b/README.md @@ -14,5 +14,40 @@ https://github.com/ETLCPP/etl See (https://www.etlcpp.com/arduino.html) for up-to-date information. +To update this repository: + +- start from a "master folder", for example in my case ```~/Desktop/Jean/Git```. +- from this "master folder", have a clone of both the etl repository (https://github.com/ETLCPP/etl or a clone of it), and the etl-arduino repository (https://github.com/ETLCPP/etl-arduino or a clone of if). +- from the etl-arduino repository, run the etl repository ```arduino/create_arduino_library.py``` script. + +For example, on my machine: + +``` +jj@MBX20:~/Desktop/Jean/Git$ ls -d etl* +etl etl-arduino +jj@MBX20:~/Desktop/Jean/Git$ cd etl-arduino/ +jj@MBX20:~/Desktop/Jean/Git/etl-arduino$ python3 ../etl/arduino/create_arduino_library.py + +Copy ETL files to the etl-arduino repository + +arduino_dir = ../etl/arduino +etl_dir = ../etl +include_dir = ../etl/include +common_dir = .. +etl_arduino_dir = ../etl-arduino +etl_arduino_src_dir = ../etl-arduino/src + +Copy the library properties + From : ../etl/library.properties + To : ../etl-arduino/library.properties + +Copy the Arduino ETL header + From : ../etl/arduino/Embedded_Template_Library.h + To : ../etl-arduino/src/Embedded_Template_Library.h + +Copy the ETL headers + From : ../etl/include + To : ../etl-arduino/src +``` From 0e056de686ddfc2be73437873515d79341cad6df Mon Sep 17 00:00:00 2001 From: JRT Date: Wed, 30 Jun 2021 08:40:17 +0200 Subject: [PATCH 2/2] Fix typos in the readme update --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1454e6c..dee7f61 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ https://github.com/ETLCPP/etl See (https://www.etlcpp.com/arduino.html) for up-to-date information. -To update this repository: +To update this repository locally on your machine: -- start from a "master folder", for example in my case ```~/Desktop/Jean/Git```. -- from this "master folder", have a clone of both the etl repository (https://github.com/ETLCPP/etl or a clone of it), and the etl-arduino repository (https://github.com/ETLCPP/etl-arduino or a clone of if). +- start from a "master folder", for example in my case in the following example: ```~/Desktop/Jean/Git```. +- from this "master folder", have a clone of both the etl repository (https://github.com/ETLCPP/etl or a fork of it), and the etl-arduino repository (https://github.com/ETLCPP/etl-arduino or a fork of it). - from the etl-arduino repository, run the etl repository ```arduino/create_arduino_library.py``` script. For example, on my machine: @@ -50,4 +50,5 @@ Copy the ETL headers To : ../etl-arduino/src ``` +At this point, you will then get the latest arduino-etl derived from the etl repo.