Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README needs improvement #1

Open
4 tasks
thibeaux opened this issue Feb 21, 2022 · 0 comments
Open
4 tasks

README needs improvement #1

thibeaux opened this issue Feb 21, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@thibeaux
Copy link
Owner

  • I'm sure there are spelling and grammar errors that I missed that need to be corrected.

  • I also need to explain what the struct is doing and what data it represents because the original code doesn't really specify, and I don't want to assume. So I will have to run some test and do some investigating.

  • I would also like to add more content to the usage section to explain why and how to use the newly added functions, even though this is sort of documented in the INA219.c file. Also explain the rational for each of the functions.

  • I would like to add more detail to the "building the project" section to explain why I added the wire going from the VIN- pin to the external power supply pin of the micro controller. To remove any guessing for anyone interested in the project.

@thibeaux thibeaux added the documentation Improvements or additions to documentation label Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant