From e6808d3bc6012803bfc21978bff83b6b9b15d700 Mon Sep 17 00:00:00 2001
From: Caril Martinez <caril.martinez@cti.espol.edu.ec>
Date: Tue, 29 Oct 2024 19:27:56 +0000
Subject: [PATCH] Update variants configuration in README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index e724c8c..3b0ee89 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,32 @@ Other required libraries, such as **Adafruit_TinyUSB.h**, **TouchScreen.h**, **B
 5. Go to **Tools > Board > Board Manager**, search for "Adafruit nRF52" and install **Adafruit nRF52 by Adafruit**.
 6. Once installed, select **Adafruit Feather nRF52840 Express** from **Tools > Board** to configure the system.
 
+### Custom Variant Configuration
+
+To ensure the NEST wearable prototype firmware operates correctly on the **Adafruit Feather nRF52840 Express**, the project includes a custom variant configuration. These custom `variant` files define specific pin mappings and settings tailored to the NEST hardware.
+
+#### Steps to Set Up the Custom Variant
+
+1. **Locate the Custom Variant Files in the Repository**:
+   - In this repository, the custom variant configuration is stored in `variants/feather_nrf52840_express`, which contains two essential files:
+     - **variant.cpp**: Maps the physical pins to the Arduino pin numbers and sets up board-specific initialization.
+     - **variant.h**: Defines hardware configurations, such as default pin assignments, ADC settings, and PWM characteristics.
+
+2. **Copy the Custom Variant Files**:
+   - Copy the entire `feather_nrf52840_express` folder from the repository’s `variants` directory to your Arduino Core’s nRF52840 variant directory.
+
+3. **Paste the Folder in the Arduino Core nRF52840 Variants Directory**:
+   - Paste the copied folder into the nRF52840 `variants` directory based on your operating system:
+     - **Windows**: `C:\Users\YOUR_USERNAME\AppData\Local\Arduino15\packages\adafruit\hardware\nrf52\<version>\variants`
+     - **macOS**: `~/Library/Arduino15/packages/adafruit/hardware/nrf52/<version>/variants`
+     - **Linux**: `~/.arduino15/packages/adafruit/hardware/nrf52/<version>/variants`
+
+4. **Verify Board Selection in Arduino IDE**:
+   - After copying the files, ensure that you have **Adafruit Feather nRF52840 Express** selected as your board in the Arduino IDE.
+
+By following these steps, you will set up the custom pin configurations and board settings necessary for this project.
+
+
 ## Bootloader
 
 The bootloader must be manually flashed. In this repository, you will find the file that needs to be flashed to the nRF52840 in the `/bootloader` directory. Follow the instructions below to flash the bootloader.
-- 
GitLab