This PR is a draft, do not merge into master until I have made all the other important changes.
This pull request Aims to implement the following:
Improved wording of motor module
Documentation clarification relevant to the PYNQ Bootcamp Interns setting up a board and contributing upstream
Proposed changes
The motor module was in need of a bit rewording around relevant blocks of code and when the Arduino
MicroBlaze Module is touched on.
I also have gone ahead and added some documentation on the methods that I used to help configure and setup
my PYNQ board, since the official documentation was a bit confusing and unorganized. This documentation may be need to be check by others for clarity. I plan to contribute to upstream's documentation to clarify such for future users.
Along with that, I highly encourage the maintainers of this repository to consider adding a license for the code.
I recommend either the BSD 3-Clause or MIT licenses, which are the standard choices for permissive lisences.
I currently don't have all of my local commits pushed yet, so they will come in due time. Just don't merge until then.
This PR is a draft, do not merge into
master
until I have made all the other important changes. This pull request Aims to implement the following:Proposed changes
The motor module was in need of a bit rewording around relevant blocks of code and when the Arduino MicroBlaze Module is touched on. I also have gone ahead and added some documentation on the methods that I used to help configure and setup my PYNQ board, since the official documentation was a bit confusing and unorganized. This documentation may be need to be check by others for clarity. I plan to contribute to upstream's documentation to clarify such for future users.
Along with that, I highly encourage the maintainers of this repository to consider adding a license for the code. I recommend either the BSD 3-Clause or MIT licenses, which are the standard choices for permissive lisences.
I currently don't have all of my local commits pushed yet, so they will come in due time. Just don't merge until then.