Skip to content

Commit

Permalink
πŸ“ docs(include): add README for project header files
Browse files Browse the repository at this point in the history
- provide guidance on using header files in the project
- link to official GCC documentation for further reading

πŸ“ docs(test): add README for PlatformIO test runner

- explain purpose of the test directory
- emphasize the importance of unit testing
- link to PlatformIO documentation for unit testing

πŸ”§ chore(vscode): add .gitignore and extensions.json

- ignore specific VSCode and PlatformIO files
- recommend PlatformIO IDE extension for VSCode
- specify unwanted extension recommendations

πŸ“¦ build(platformio): add platformio.ini configuration

- configure PlatformIO for Raspberry Pi Pico
- set board framework to Arduino

✨ feat(src): add basic Arduino setup and loop

- implement a simple function demonstrating setup and loop
- create myFunction as a sample function for addition
  • Loading branch information
isfopo committed Dec 1, 2024
1 parent 31bff80 commit 8c10ee4
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 0 deletions.
5 changes: 5 additions & 0 deletions embedded/LoopPedal/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch
10 changes: 10 additions & 0 deletions embedded/LoopPedal/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"platformio.platformio-ide"
],
"unwantedRecommendations": [
"ms-vscode.cpptools-extension-pack"
]
}
39 changes: 39 additions & 0 deletions embedded/LoopPedal/include/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

This directory is intended for project header files.

A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.

```src/main.c

#include "header.h"

int main (void)
{
...
}
```

Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.

In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.

Read more about using header files in official GCC documentation:

* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes

https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
14 changes: 14 additions & 0 deletions embedded/LoopPedal/platformio.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[env:pico]
platform = raspberrypi
board = pico
framework = arduino
18 changes: 18 additions & 0 deletions embedded/LoopPedal/src/main.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#include <Arduino.h>

// put function declarations here:
int myFunction(int, int);

void setup() {
// put your setup code here, to run once:
int result = myFunction(2, 3);
}

void loop() {
// put your main code here, to run repeatedly:
}

// put function definitions here:
int myFunction(int x, int y) {
return x + y;
}
11 changes: 11 additions & 0 deletions embedded/LoopPedal/test/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

This directory is intended for PlatformIO Test Runner and project tests.

Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.

More information about PlatformIO Unit Testing:
- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html

0 comments on commit 8c10ee4

Please sign in to comment.