From 2d3f7ee5a3dd6ce39a30c6a07fecfddcf3d579f3 Mon Sep 17 00:00:00 2001 From: Jeffersonbenson Date: Mon, 18 Jan 2021 16:47:56 -0500 Subject: [PATCH] Added Contributing and License, reorganized Hardware Added a basic template for the Contributing guide and a placeholder file for whenever a proper license can be determined. Also created the BOMs folder with subfolders for each version of the BOM. More clarity is needed to further organize the Hardware folder --- CONTRIBUTING.md | 30 ++++++++++++++++++ .../Final Video Script.docx | Bin .../PSDR2 Guide.pdf | Bin .../PortableSDR Video Script.docx | Bin Hardware/{ => Amp}/Amp_Board_v1_BOM.xlsx | Bin Hardware/{ => Amp}/Amp_board_v1 Schematic.pdf | Bin Hardware/{ => Amp}/Amp_board_v1.pcb | Bin Hardware/{ => Amp}/Amp_board_v1.sch | Bin .../Bottom Assembly Diagram.pdf | Bin .../{ => Assembly}/Top Assembly Diagram.pdf | Bin Hardware/{ => BOMs/PSDR_1.0.0}/PSDR1_BOM.xlsx | Bin Hardware/{ => BOMs/PSDR_2.0.0}/PSDR2_BOM.xlsx | Bin .../PSDR_2.0.0}/PSDR2_BOM_Simple.xlsx | Bin .../PSDR_2.0.0}/PSDR2_BOMwithoutAmp.xlsx | Bin .../{ => BOMs/PSDR_2.0.0}/PSDR2_MainBoard.DXF | 0 .../PSDR_2.0.0}/~$PSDR2_BOM_Simple.xlsx | Bin .../{ => BOMs/PSDR_2.5.0}/PSDR2.5_BOM.ods | Bin .../{ => BOMs/PSDR_2.5.0}/PSDR2.5_BOM.xls | Bin .../PSDR_2.5.0}/STM32F429_Config.ioc | 0 .../{ => BOMs/PSDR_2.6.1}/PSDR2.6.1_BOM.xls | Bin .../{ => BOMs/PSDR_2.6.1}/PSDR2.6_BOM.xls | Bin .../PSDR_2.6.1}/STM32F756_Config.ioc | 0 Hardware/{ => BOMs/PSDR_2.6.1}/psdr26.emn | 0 Hardware/{ => BOMs/PSDR_2.6.1}/psdr26.emp | 0 .../{ => Block_Diagram}/Block Diagram.pdf | Bin .../{ => Block_Diagram}/Block Diagram.png | Bin .../{ => Block_Diagram}/Block Diagram.vsd | Bin .../{ => Encoder}/PSDR_Encoder Schematic.pdf | Bin Hardware/{ => Encoder}/PSDR_Encoder.pcb | Bin Hardware/{ => Encoder}/PSDR_Encoder.sch | Bin LICENSE.md | 1 + 31 files changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md rename Final Video Script.docx => Documentation/Final Video Script.docx (100%) rename PSDR2 Guide.pdf => Documentation/PSDR2 Guide.pdf (100%) rename PortableSDR Video Script.docx => Documentation/PortableSDR Video Script.docx (100%) rename Hardware/{ => Amp}/Amp_Board_v1_BOM.xlsx (100%) rename Hardware/{ => Amp}/Amp_board_v1 Schematic.pdf (100%) rename Hardware/{ => Amp}/Amp_board_v1.pcb (100%) rename Hardware/{ => Amp}/Amp_board_v1.sch (100%) rename Hardware/{ => Assembly}/Bottom Assembly Diagram.pdf (100%) rename Hardware/{ => Assembly}/Top Assembly Diagram.pdf (100%) rename Hardware/{ => BOMs/PSDR_1.0.0}/PSDR1_BOM.xlsx (100%) rename Hardware/{ => BOMs/PSDR_2.0.0}/PSDR2_BOM.xlsx (100%) rename Hardware/{ => BOMs/PSDR_2.0.0}/PSDR2_BOM_Simple.xlsx (100%) rename Hardware/{ => BOMs/PSDR_2.0.0}/PSDR2_BOMwithoutAmp.xlsx (100%) rename Hardware/{ => BOMs/PSDR_2.0.0}/PSDR2_MainBoard.DXF (100%) rename Hardware/{ => BOMs/PSDR_2.0.0}/~$PSDR2_BOM_Simple.xlsx (100%) rename Hardware/{ => BOMs/PSDR_2.5.0}/PSDR2.5_BOM.ods (100%) rename Hardware/{ => BOMs/PSDR_2.5.0}/PSDR2.5_BOM.xls (100%) rename Hardware/{ => BOMs/PSDR_2.5.0}/STM32F429_Config.ioc (100%) rename Hardware/{ => BOMs/PSDR_2.6.1}/PSDR2.6.1_BOM.xls (100%) rename Hardware/{ => BOMs/PSDR_2.6.1}/PSDR2.6_BOM.xls (100%) rename Hardware/{ => BOMs/PSDR_2.6.1}/STM32F756_Config.ioc (100%) rename Hardware/{ => BOMs/PSDR_2.6.1}/psdr26.emn (100%) rename Hardware/{ => BOMs/PSDR_2.6.1}/psdr26.emp (100%) rename Hardware/{ => Block_Diagram}/Block Diagram.pdf (100%) rename Hardware/{ => Block_Diagram}/Block Diagram.png (100%) rename Hardware/{ => Block_Diagram}/Block Diagram.vsd (100%) rename Hardware/{ => Encoder}/PSDR_Encoder Schematic.pdf (100%) rename Hardware/{ => Encoder}/PSDR_Encoder.pcb (100%) rename Hardware/{ => Encoder}/PSDR_Encoder.sch (100%) create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..583f0b8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to the Project +There is obviously a lot of work required to get this project off the ground, and get the PortableSDR into as many hands as want it. In order to help coordinate every hand that wants to help develop the projcet, here are a few guidelines we ask the community to follow. + +Note: It is not necessary to be a licensed ham operator in order to work on this project, but it is highly encouraged that contributors contact their local ham radio club for assistance in obtaining a license to transmit. + +Another Note: All pull requests and branches shall written in a professional and friendly manner. This extends to any discussion within a PR or branch. No attitudes on the airwaves! + +## How to Contribute + +Glad you asked! There are always ways for individuals to contribute with developing, testing, and planning new features for the project. + +Here are some helpful resources: +- For discussion of features, use the Discussions tab in Github +- Bugs? Report them in the `Issues` tab + +## Testing + For hardware testing, you may need to order a board and populate it with the BOM. Two places to order PCBs that come to mind are [OSHPark](oshpark.com) and [PCB:NG](pcb.ng), though PCB:NG might be better for a production run scenario instead of just test boards. + + For software testing, refer to the build instructions found in the `Documentation` folder for how to run smoke testing on code. Soon there will also be an automated testing route that contributors can take advantage of using the GitHub `Actions` section. + +## Submitting Changes +Please submit a GitHub Pull Request along with a clear list of what changes you have made.Additionally, if your PR is related to a particular project task, please reference that task so appropriate tracking can be done. + +If possible, please submit a few sentences regarding larger commits. One-line messages are fine for smaller changes, but bigger changes should be formatted as follows: +```bash + $ git commit -m "A brief summary of the commit" -m "A paragraph describing what changed and its impact." +``` + +## Coding Conventions +TBD diff --git a/Final Video Script.docx b/Documentation/Final Video Script.docx similarity index 100% rename from Final Video Script.docx rename to Documentation/Final Video Script.docx diff --git a/PSDR2 Guide.pdf b/Documentation/PSDR2 Guide.pdf similarity index 100% rename from PSDR2 Guide.pdf rename to Documentation/PSDR2 Guide.pdf diff --git a/PortableSDR Video Script.docx b/Documentation/PortableSDR Video Script.docx similarity index 100% rename from PortableSDR Video Script.docx rename to Documentation/PortableSDR Video Script.docx diff --git a/Hardware/Amp_Board_v1_BOM.xlsx b/Hardware/Amp/Amp_Board_v1_BOM.xlsx similarity index 100% rename from Hardware/Amp_Board_v1_BOM.xlsx rename to Hardware/Amp/Amp_Board_v1_BOM.xlsx diff --git a/Hardware/Amp_board_v1 Schematic.pdf b/Hardware/Amp/Amp_board_v1 Schematic.pdf similarity index 100% rename from Hardware/Amp_board_v1 Schematic.pdf rename to Hardware/Amp/Amp_board_v1 Schematic.pdf diff --git a/Hardware/Amp_board_v1.pcb b/Hardware/Amp/Amp_board_v1.pcb similarity index 100% rename from Hardware/Amp_board_v1.pcb rename to Hardware/Amp/Amp_board_v1.pcb diff --git a/Hardware/Amp_board_v1.sch b/Hardware/Amp/Amp_board_v1.sch similarity index 100% rename from Hardware/Amp_board_v1.sch rename to Hardware/Amp/Amp_board_v1.sch diff --git a/Hardware/Bottom Assembly Diagram.pdf b/Hardware/Assembly/Bottom Assembly Diagram.pdf similarity index 100% rename from Hardware/Bottom Assembly Diagram.pdf rename to Hardware/Assembly/Bottom Assembly Diagram.pdf diff --git a/Hardware/Top Assembly Diagram.pdf b/Hardware/Assembly/Top Assembly Diagram.pdf similarity index 100% rename from Hardware/Top Assembly Diagram.pdf rename to Hardware/Assembly/Top Assembly Diagram.pdf diff --git a/Hardware/PSDR1_BOM.xlsx b/Hardware/BOMs/PSDR_1.0.0/PSDR1_BOM.xlsx similarity index 100% rename from Hardware/PSDR1_BOM.xlsx rename to Hardware/BOMs/PSDR_1.0.0/PSDR1_BOM.xlsx diff --git a/Hardware/PSDR2_BOM.xlsx b/Hardware/BOMs/PSDR_2.0.0/PSDR2_BOM.xlsx similarity index 100% rename from Hardware/PSDR2_BOM.xlsx rename to Hardware/BOMs/PSDR_2.0.0/PSDR2_BOM.xlsx diff --git a/Hardware/PSDR2_BOM_Simple.xlsx b/Hardware/BOMs/PSDR_2.0.0/PSDR2_BOM_Simple.xlsx similarity index 100% rename from Hardware/PSDR2_BOM_Simple.xlsx rename to Hardware/BOMs/PSDR_2.0.0/PSDR2_BOM_Simple.xlsx diff --git a/Hardware/PSDR2_BOMwithoutAmp.xlsx b/Hardware/BOMs/PSDR_2.0.0/PSDR2_BOMwithoutAmp.xlsx similarity index 100% rename from Hardware/PSDR2_BOMwithoutAmp.xlsx rename to Hardware/BOMs/PSDR_2.0.0/PSDR2_BOMwithoutAmp.xlsx diff --git a/Hardware/PSDR2_MainBoard.DXF b/Hardware/BOMs/PSDR_2.0.0/PSDR2_MainBoard.DXF similarity index 100% rename from Hardware/PSDR2_MainBoard.DXF rename to Hardware/BOMs/PSDR_2.0.0/PSDR2_MainBoard.DXF diff --git a/Hardware/~$PSDR2_BOM_Simple.xlsx b/Hardware/BOMs/PSDR_2.0.0/~$PSDR2_BOM_Simple.xlsx similarity index 100% rename from Hardware/~$PSDR2_BOM_Simple.xlsx rename to Hardware/BOMs/PSDR_2.0.0/~$PSDR2_BOM_Simple.xlsx diff --git a/Hardware/PSDR2.5_BOM.ods b/Hardware/BOMs/PSDR_2.5.0/PSDR2.5_BOM.ods similarity index 100% rename from Hardware/PSDR2.5_BOM.ods rename to Hardware/BOMs/PSDR_2.5.0/PSDR2.5_BOM.ods diff --git a/Hardware/PSDR2.5_BOM.xls b/Hardware/BOMs/PSDR_2.5.0/PSDR2.5_BOM.xls similarity index 100% rename from Hardware/PSDR2.5_BOM.xls rename to Hardware/BOMs/PSDR_2.5.0/PSDR2.5_BOM.xls diff --git a/Hardware/STM32F429_Config.ioc b/Hardware/BOMs/PSDR_2.5.0/STM32F429_Config.ioc similarity index 100% rename from Hardware/STM32F429_Config.ioc rename to Hardware/BOMs/PSDR_2.5.0/STM32F429_Config.ioc diff --git a/Hardware/PSDR2.6.1_BOM.xls b/Hardware/BOMs/PSDR_2.6.1/PSDR2.6.1_BOM.xls similarity index 100% rename from Hardware/PSDR2.6.1_BOM.xls rename to Hardware/BOMs/PSDR_2.6.1/PSDR2.6.1_BOM.xls diff --git a/Hardware/PSDR2.6_BOM.xls b/Hardware/BOMs/PSDR_2.6.1/PSDR2.6_BOM.xls similarity index 100% rename from Hardware/PSDR2.6_BOM.xls rename to Hardware/BOMs/PSDR_2.6.1/PSDR2.6_BOM.xls diff --git a/Hardware/STM32F756_Config.ioc b/Hardware/BOMs/PSDR_2.6.1/STM32F756_Config.ioc similarity index 100% rename from Hardware/STM32F756_Config.ioc rename to Hardware/BOMs/PSDR_2.6.1/STM32F756_Config.ioc diff --git a/Hardware/psdr26.emn b/Hardware/BOMs/PSDR_2.6.1/psdr26.emn similarity index 100% rename from Hardware/psdr26.emn rename to Hardware/BOMs/PSDR_2.6.1/psdr26.emn diff --git a/Hardware/psdr26.emp b/Hardware/BOMs/PSDR_2.6.1/psdr26.emp similarity index 100% rename from Hardware/psdr26.emp rename to Hardware/BOMs/PSDR_2.6.1/psdr26.emp diff --git a/Hardware/Block Diagram.pdf b/Hardware/Block_Diagram/Block Diagram.pdf similarity index 100% rename from Hardware/Block Diagram.pdf rename to Hardware/Block_Diagram/Block Diagram.pdf diff --git a/Hardware/Block Diagram.png b/Hardware/Block_Diagram/Block Diagram.png similarity index 100% rename from Hardware/Block Diagram.png rename to Hardware/Block_Diagram/Block Diagram.png diff --git a/Hardware/Block Diagram.vsd b/Hardware/Block_Diagram/Block Diagram.vsd similarity index 100% rename from Hardware/Block Diagram.vsd rename to Hardware/Block_Diagram/Block Diagram.vsd diff --git a/Hardware/PSDR_Encoder Schematic.pdf b/Hardware/Encoder/PSDR_Encoder Schematic.pdf similarity index 100% rename from Hardware/PSDR_Encoder Schematic.pdf rename to Hardware/Encoder/PSDR_Encoder Schematic.pdf diff --git a/Hardware/PSDR_Encoder.pcb b/Hardware/Encoder/PSDR_Encoder.pcb similarity index 100% rename from Hardware/PSDR_Encoder.pcb rename to Hardware/Encoder/PSDR_Encoder.pcb diff --git a/Hardware/PSDR_Encoder.sch b/Hardware/Encoder/PSDR_Encoder.sch similarity index 100% rename from Hardware/PSDR_Encoder.sch rename to Hardware/Encoder/PSDR_Encoder.sch diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f427039 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1 @@ +TODO: Determine the best license for this project