From 1ee05da5d12c824dc0bcabc50e96031f300ecd8c Mon Sep 17 00:00:00 2001 From: hestia Date: Fri, 28 Feb 2025 09:48:58 -0600 Subject: [PATCH 1/2] docs: added some details about how to compile and contribute changes upstream --- docs/howto-compile.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/howto-compile.md b/docs/howto-compile.md index 41a8eb2..bcf984f 100644 --- a/docs/howto-compile.md +++ b/docs/howto-compile.md @@ -100,6 +100,3 @@ There are 2 environment options to compile this project, PlatformIO and ArduinoI - For PlatformIO, it should work out of the box - For arduino, files in `src` folder and also from `Examples` can be modified at `Documents/Arduino/libraries` for Windows and Mac, and `~/Arduino/Libraries` for Linux - - - From 21b9ddb2ed2617a1ce277cdf84dffa7032a815a3 Mon Sep 17 00:00:00 2001 From: hestiahacker <116128976+hestiahacker@users.noreply.github.com> Date: Sun, 11 May 2025 01:06:53 -0500 Subject: [PATCH 2/2] Improved contribution instructions Improved wording suggested by @Iroxxar --- docs/howto-compile.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto-compile.md b/docs/howto-compile.md index bcf984f..3288f2f 100644 --- a/docs/howto-compile.md +++ b/docs/howto-compile.md @@ -90,7 +90,7 @@ Choose based on how python installed on your machine. But most user, using `apt` ## How to contribute -The instructions above are the instructions for how to build an official release of the AirGradient firmware using the Arduino IDE. If you intend to make changes that will you intent to contribute back to the main project, instead of installing the AirGradient library, check out the repo at `Documents/Arduino/libraries` (for Windows and Mac), or `~/Arduino/Libraries` (Linux). If you installed the library, you can remove it from the library manager in the Arduino IDE, or just delete the directory. +The instructions above are the instructions for how to build an official release of the AirGradient firmware using the Arduino IDE. If you intend to make changes which you plan to contribute back to the main project, instead of installing the AirGradient library, check out the repository at Documents/Arduino/libraries (for Windows and Mac) or ~/Arduino/libraries (for Linux). If you installed the library, you can remove it from the library manager in the Arduino IDE, or just delete the directory. **NOTE:** When cloning the repository, for version >= 3.3.0 it has submodule, please use `--recursive` flag like this: `git clone --recursive https://github.com/airgradienthq/arduino.git AirGradient_Air_Quality_Sensor`