From 293e779aa61d7bf20922e96e1f9d835dc73bd7da Mon Sep 17 00:00:00 2001 From: sebgab Date: Wed, 18 Jun 2025 19:44:48 +0000 Subject: [PATCH] Initial commit --- Documentation/README.md | 6 ++++++ Firmware/README.md | 3 +++ Hardware-Electrical/README.md | 3 +++ Hardware-Mechanical/README.md | 4 ++++ README.md | 13 +++++++++++++ 5 files changed, 29 insertions(+) create mode 100644 Documentation/README.md create mode 100644 Firmware/README.md create mode 100644 Hardware-Electrical/README.md create mode 100644 Hardware-Mechanical/README.md create mode 100644 README.md diff --git a/Documentation/README.md b/Documentation/README.md new file mode 100644 index 0000000..f307454 --- /dev/null +++ b/Documentation/README.md @@ -0,0 +1,6 @@ +# Documentation + +This folder should contain the documentation used for this project. + +This includes any references, not a part of the datasheet linked +in symbols (for EDA), etc. or any calculations for the project. diff --git a/Firmware/README.md b/Firmware/README.md new file mode 100644 index 0000000..e180323 --- /dev/null +++ b/Firmware/README.md @@ -0,0 +1,3 @@ +# Firmware + +This folder should contain any firmware intended to be run on the project. diff --git a/Hardware-Electrical/README.md b/Hardware-Electrical/README.md new file mode 100644 index 0000000..6784637 --- /dev/null +++ b/Hardware-Electrical/README.md @@ -0,0 +1,3 @@ +# Hardware - Electrical + +This folder should contain the electrical design on the project in a subfolder. diff --git a/Hardware-Mechanical/README.md b/Hardware-Mechanical/README.md new file mode 100644 index 0000000..f7231d6 --- /dev/null +++ b/Hardware-Mechanical/README.md @@ -0,0 +1,4 @@ +# Hardware - Mechanical + +This folder should contain the mechanical design for a project, if it is present. +If mechanical design is not needed for the project feel free to delete this folder. diff --git a/README.md b/README.md new file mode 100644 index 0000000..523f6ff --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# PROJECT NAME HERE + +## Background + +Why does this project exist? + +## Project specification + +What does this project need to do? + +## How to use + +How do I use this project?