MPAE-18679 - grammatical and formatting updates to README.MD, replacing some images with higher quality and resizing to meet formatting guidelines, upgrading MPLABX project to latest versions

Author: jason-layton

25csm04.X/nbproject/configurations.xml

@@ -81,7 +81,7 @@
         <targetDevice>PIC18F56Q24</targetDevice>
         <targetHeader></targetHeader>
         <targetPluginBoard></targetPluginBoard>
-        <platformTool>nEdbgTool</platformTool>
+        <platformTool>noID</platformTool>
         <languageToolchain>XC8</languageToolchain>
         <languageToolchainVersion>3.00</languageToolchainVersion>
         <platform>3</platform>

README.md

@@ -8,13 +8,13 @@
    </picture>
 </a>
 
-#  How to Set Up a Curiosity Nano Explorer 25CSM04 EEPROM using a PIC18F56Q24 MCU
+# Interfacing the 25CSM04 EEPROM on the Curiosity Nano Explorer development board using a PIC18F56Q24 Curiosity Nano
 
-This example demonstrates the setup of 25CSM04 EEPROM on a PIC18F56Q24 microcontroller (MCU) . The 25CSM04 is an 4M bit Serial Peripheral Interface (SPI) serial EEPROM.
+This example demonstrates the setup and configuration of the 25CSM04 EEPROM using the PIC18F56Q24 microcontroller. The 25CSM04 is a 4 Mbit Serial Peripheral Interface (SPI) serial EEPROM, designed to provide reliable, high-density non-volatile memory storage. By interfacing the 25CSM04 using the PIC18F56Q24 Curiosity Nano, this example highlights how to efficiently store and retrieve data using SPI communication, making it ideal for applications that require robust data retention and fast access times.
 
 ## Related Documentation
 
-- [25CSM04 Data sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MPD/ProductDocuments/DataSheets/25CSM04-4-Mbit-SPI-Serial-EEPROM-with-128-Bit-Serial-Number-and-Enhanced-Write-Protection-20005817D.pdf) 
+- [25CSM04 Data sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MPD/ProductDocuments/DataSheets/25CSM04-4-Mbit-SPI-Serial-EEPROM-with-128-Bit-Serial-Number-and-Enhanced-Write-Protection-20005817D.pdf)
 - [PIC18F56Q24 Curiosity Nano User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/PIC18F56Q24-CNANO-UserGuide-DS50003618.pdf)
 - [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.pdf)
 
@@ -28,67 +28,77 @@ This example demonstrates the setup of 25CSM04 EEPROM on a PIC18F56Q24 microcont
 
 ## Hardware Used
 
-- [PIC18F56Q24 CURIOSITY NANO EVALUATION KIT ](https://www.microchip.com/en-us/development-tool/ev01e86a)
-
-![pic18f56q24](images/pic18f56q24.png)
-
-- [Curiosity Nano Explorer ](https://www.microchip.com/en-us/development-tool/ev58g97a)
+- [PIC18F56Q24 Curiosity Nano Evaluation Kit ](https://www.microchip.com/en-us/development-tool/ev01e86a)
+- [Curiosity Nano Explorer](https://www.microchip.com/en-us/development-tool/ev58g97a)
+- USB type C cable
 
 ![Curiosity Nano Explorer](images/curiositynanoexplorer.png)
 
-
-- USB type C cable
-
 ## Setup
 
-The [user guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.pdf) for the Curiosity Explorer Nano board provides the pins mapping information neede for this example.
+The [userguide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.pdf) for the Curiosity Explorer Nano board provides detailed information about the pin mapping between the Curiosity Explorer board and the PIC18F56Q24 Curiosity Nano board being used in this example.
 
 ![Explorer25CSM04](images/Explorer25CSM04.png)
 
-From the diagram above, SPI CS, SPI MOSI, SPI MISO and SPI SCK will be used to communicate with the 25CSM04 I2C EEPROM.
-   
+Based on the diagram above from the Curiosity Explorer users guide, the SPI CS, SPI MOSI, SPI MISO, and SPI SCK lines will be used to communicate with the 25CSM04 SPI EEPROM.
+
+## MCC Setup
+The detailed step by step instructions required to recreate this example are listed below:
 
-## MCC Setup 
-All instructions required to recreate this example are listed below.
+Begin by setting up UART to enable data display on the terminal.
 
-First is UART so that data can be seen on the terminal.
 ### UART Setup
-- Once MCC is open, add the UART driver and select UART2 in dependency selector
-- Make sure Redirect Printf to UART is enabled<br>
+
+The UART configuration should appear as shown below.
+- With MCC open, add the UART driver and select UART2 in the dependency selector.
+- Ensure that "Redirect Printf to UART" is enabled.
+- The UART configuration should appear as shown below.<br>
+
  ![UART setup](images/uart.png)
-- The UART2PLIB will be left as is
+
+ - No changes are required for UART2PLIB
+
 <br><br>
 
-### SPI Setup 
-- Add SPI driver and select SPI1 as SPI Host PLIB Selector 
-- Set the Requested speed to 4000 KHz and make sure the SPI Interrupt is enabled
-- The SPI configuration can also be found in the image below<br>
+### SPI Setup
+- Add the SPI driver and select SPI1 as the SPI Host PLIB Selector.
+- Set the requested speed to 4000 kHz and ensure that the SPI interrupt is enabled.
+- The SPI configuration is also shown in the image below.
+
  ![SPI setup](images/spi.png)<br>
+
  ![SPIPlib setup](images/spiplib.png)
-<br><br>
+
+<br>
 
 ### Pins Setup
-- Select the UART and SPI pins from the diagram below
+- Select the appropriate UART and SPI pins as indicated in the diagram below.
+
 ![ExplorerMCP23008](images/explorerpic1856q24mapping.png)<br>
-- The MCC for pins is shown below<br>
+
+- The MCC configuration for the pins is shown below.
+
  ![pins setup](images/pins.png)<br>
+
  ![pins1 setup](images/pins1.png)<br>
-<br><br>
 
-- Now you can click on <b>"Generate"</b> and thats all you need from MCC.
-- Add the `25CSM04.c` and `25CSM04.h` driver code to your project.
-- Modify the `main.c` according the screenshot below. <br>
+<br>
+
+- Click on "Generate" to complete the configuration in MCC.
+- Add the `25CSM04.c` and `25CSM04.h` driver code to the project.
+- Modify  `main.c` as shown in the screenshot below.
+
  ![screenshot](images/main.png)<br>
-- This code snippet calls writeReadByteTest(0x0000), which performs consecutive read and write checks from address 0x0000.
-- It displays the write and read values and verifies whether these value match.
+
+ - This code snippet calls writeReadByteTest(0x0000), which performs consecutive read and write operations starting from address 0x0000.
+ - The code displays the written and read values and verifies whether these values match.
 
 ## Operation
 
-After you program the device, you can see the output in the terminal, whether the tests have passed or failed.<br>
+After programming the device, the terminal displays the output indicating whether the tests have passed or failed.
+
 ![output](images/output.png)
 
 ## Summary
 
-This demo shows how to interface the 25CSM04 SPI EEPROM on the Curiosity Nano Explorer board using a PIC18F56Q24. 
-
-The demo has few tests where it writes to a specific location and it reads the same address to verify whether the read and write operations work. 
+This demonstration shows how to interface the 25CSM04 SPI EEPROM on the Curiosity Nano Explorer board using a PIC18F56Q24 microcontroller. In this example, several tests are performed to validate the functionality of the EEPROM interface. Data is written to a specific memory location, and then read back from the same address to ensure that both the write and read operations are working correctly. The results of these tests are displayed on the terminal, providing clear feedback on the success or failure of each operation.