Skip to content

Commit dfe9f64

Browse files
committed
Minor fixes
1 parent 9e51972 commit dfe9f64

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/mainpage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Raspberry Pi Pico SDK
22

3-
The Raspberry Pi Pico Software Development Kit, hereafter **SDK**, provides the headers, libraries, and build system necessary to write programs for RP-series microcontroller devices such as the Raspberry Pi Pico in C, C++, or assembly language. The SDK is designed to provide an API (Application Programming Interface) and programming environment that is familiar both to non-embedded C developers and embedded C developers.
3+
The Raspberry Pi Pico Software Development Kit, hereafter **SDK**, provides the headers, libraries, and build system necessary to write programs for RP-series microcontroller devices such as the Raspberry Pi Pico in C, C++, or assembly language. The SDK is designed to provide an API (Application Programming Interface) and programming environment that's familiar both to both non-embedded and embedded C developers.
44

5-
A single program runs on the device at a time, with a conventional `main()` method. Standard C and C++ libraries are supported, along with APIs for accessing the microcontroller's hardware, including DMA, IRQs, and wide variety of fixed-function peripherals and PIO (Programmable IO).
5+
A single program runs on the device at a time, with a conventional `main()` method. Standard C and C++ libraries are supported, along with APIs for accessing a microcontroller's hardware, including DMA, IRQs, and wide variety of fixed-function peripherals and PIO (Programmable IO).
66

77
Additionally, the SDK provides higher-level libraries for dealing with timers, USB, synchronisation, and multi-core programming, along with high-level functionality built using PIO (such as audio). The SDK can be used to build anything from simple applications to full-fledged runtime environments such as MicroPython, or even low-level software, such as the microcontroller's on-chip boot ROM.
88

9-
This documentation is generated from the SDK source tree using Doxygen. It provides basic information on the APIs used for each library, but doesn't provide usage information. For more technical information and usage guidance, refer to the Raspberry Pi databooks.
9+
This documentation is generated from the SDK source tree using Doxygen. It provides basic information on the APIs used for each library, but doesn't provide usage information. For more technical information and usage guidance, refer to the Raspberry Pi datasheets.
1010

1111
## SDK Design
1212

13-
The RP-series microcontrollers are powerful chips designed for embedded systems, which means that these chips operate in environments with limited memory (RAM) and storage (program space).As a result, trade-offs between performance and other factors, (such as edge-case error handling, runtime versus compile time configuration, and soon) are more apparent than they might be on higher-level platforms (like desktop systems).
13+
The RP-series microcontrollers are powerful chips designed for embedded systems; these chips operate in environments with limited memory (RAM) and storage (program space). As a result, trade-offs between performance and other factors (such as edge-case error handling, runtime versus compile time configuration, and so on) are more apparent than they might be on higher-level platforms (like desktop systems).
1414

15-
The SDK is designed to be both beginner friendly and powerful for more experienced users. Its features work out-of-the-box, with sensible defaults that cover most use cases. At the same time, it gives developers as much control as possible to refine the application they're building and the libraries used, if they choose to.
15+
The SDK is designed to be both beginner friendly and powerful for more experienced users. Its features work out-of-the-box, with sensible defaults that cover most use cases. At the same time, it gives developers as much control as possible to adjust and refine the application they're building and the libraries used, if they choose to.
1616

1717
## The Build System
1818

19-
The SDK uses **CMake** to manage the build process. CMake is a widely used build system for C and C++ development and is supported by many IDEs (Integrated Development Environments). It allows developers to specify build instructions using `CMakeLists.txt` files, from which CMake can generate platform-specific build systems for tools like `make` and `ninja`. These builds can be customised for the intended platform and configuration variables defined by the developer.
19+
The SDK uses **CMake** to manage the build process. CMake is a widely used build system for C and C++ development, and is supported by many IDEs (Integrated Development Environments). It allows developers to specify build instructions using `CMakeLists.txt` files, from which CMake can generate platform-specific build systems for tools like `make` and `ninja`. These builds can be customised for the intended platform and configuration variables defined by the developer.
2020

2121
Apart from its popularity, CMake is fundamental to how the SDK is structured, and how applications are configured and built. It enables consistent builds across platforms while providing flexibility for more complex embedded projects.
2222

0 commit comments

Comments
 (0)