feat v1.0.7: rebased the repository to be more clear where everything…

[ThomasNels]

Description

This rebases the repository by doing a couple of things. The first is removing the cppExample_alg01 folder and moving all the information in that folder over to the src folder. The second is changing the pyExample_alg01 information to reflect these changes. These solves the issues referenced below because it transfers the source code itself into the src folder. Beforehand it was very unclear where the actual source code was.

Requirements

• Overview the repository changes to see if there are any major issues with changes. No need to run through any examples.

Issues Referenced

• Fixes #3
• The repository was not following the principles behind its initial setup. This rebase changes that to follow the idea of that structure.

Documentation update

Documentation update to README_py.md

Notes for Reviewer

• This is just some quick changes to the repository. Other than the description there isn't any major details to consider.

Testing

• Nothing to test

Results

Took this structure:

EmotiBit_Plugins
├── ardExample_alg01
│   └── ardExample_alg01.ino
├── cppExample_alg01
│   ├── CMakeLists.txt
│   └── driver.cpp
├── ofExample_alg01
│   └── src
│       └── ofapp.cpp
├── pyExample_alg01
│   ├── EmotiBit-pyenv-modern.yml
│   └── pyExample_alg01.py
├── src
│   ├── alg01.cpp
│   └── alg01.h
├── .gitignore
├── LICENSE
├── README.md
├── README_ard.md
├── README_of.md
├── README_py.md
└── library.properties

and moved to this structure:

EmotiBit_Plugins
├── ardExample_alg01
│   └── ardExample_alg01.ino
├── ofExample_alg01
│   └── src
│       └── ofapp.cpp
├── pyExample_alg01
│   ├── EmotiBit-pyenv-modern.yml
│   └── pyExample_alg01.py
├── src
│   ├── alg01.cpp
│   ├── alg01.h
│   ├── CMakeLists.txt
│   └── driver.cpp
├── .gitignore
├── LICENSE
├── README.md
├── README_ard.md
├── README_of.md
├── README_py.md
└── library.properties

Feature Tests

N/A

Shared files

N/A

Checklist to allow merge

• [ ] All dependent repositories used were on branch master
• Software
  • [ ] Get approval from the reviewer
  • [ ] Passed testing on Windows
• [ ] Required documentation updated

Screenshots:

[nitin710]

Review 01

• Just some comments to address the PR. Since the PR is small, I'll address the process more than the changes.
• I like the folder structure explained in the results. The only change I would suggest to maybe move that to the Issue itself. This way the issue has the problem and the solution. And the PR/results itself can contain a brief description of the change. This is especially beneficial for PRs with many issues referenced. Adding details results in the results section makes the PR bloated.
• I think the requirements section could have been left blank. Something to think about maybe.
• From our conversations on slack,
  • driver.cpp is equivalent of main.cpp (for future reference for nitin)
• did not test the py example. trusting dev tested all examples before staging PR.

Approved for merge. @ThomasNels