Project Contributions
We are excited to see the innovative ways in which you are utilizing SensEdu. By submitting your project, you have the opportunity to have it listed as a showcase for SensEdu functionality and included in the main repository.
To submit your project, please follow these steps:
- Fork SensEdu repository
- Add a new project folder in your fork
~\projects\my_project\
- Create an Arduino sketch
~\projects\my_project\my_project.ino
. Ensure that the sketch filename matches the folder name- If you have additional files (e.g., MATLAB scripts), place them in the subfolder within your project folder, such as
~\projects\my_project\matlab\my_script.m
- If you have additional files (e.g., MATLAB scripts), place them in the subfolder within your project folder, such as
- Create a documentation for your project
- Create a new markdown page
~\docs\Projects\my_project.md
- Add the following fields to the markdown header:
--- title: My Project layout: default parent: Projects nav_order: 10 ---
- The order of projects is defined by
nav_order
. Use the next available number for proper website navigation. Customizetitle
with your project name - Follow Documentation Contributions for detailed page creation guidelines
- Share implementation details and nice pictures of you project!
- Create a new markdown page
- Commit all changes to your fork and submit a Pull Request (PR) to the main SensEdu repository