Rename library so it doesn't conflict with original TVout library #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All relevant file and folder names were changed to suit the new library name and all references in any relevant files were also changed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think it might be best to rename this library so that it does not conflict with the original TVout library. While I don't think anyone would reasonably want to use both at the same time, I think there could be benefit to having both installed in the Arduino app, namely: the original TVout library is (a little bit) simpler, there seems to be more use and discussion about the original TVout library, and the original TVout library seems to still have some minor development/upkeep work happening. (I don't mean any of this as slights against the VE version, just as points to the original's credit. In fact I only plan to work with the VE version myself going forward.)
I think the name might be a little better if it were VE_TVout (or Nootropic_TVout or similar) for both practical reasons (it'd just be a prefix to add to any TVout instances) and stylistic reasons, but I made it TVout_ve since the repo was already called arduino-tvout-ve. So if the maintainer would prefer a prefix name scheme, I'm all for it, and will happily rework a pull request to suit. Just let me know.
The following files/folders that were changed:
TVout/=>TVout_ve/TVout.cpp=>TVout_ve.cppTVout.h=>TVout_ve.hTVoutPrint.cpp=>TVout_vePrint.cppInside the files, all mention of the above files/folders were changed to match.
Also inside the files, the following things (and all references to them) were changed:
TVout=>TVout_veTVOUT_H=>TVOUT_VE_HTVout_vid=>TVout_ve_vidThe README.md file too was updated to reflect the new name (though I seem to have misspelled 'README' in my commit message -- whoops).
The folder TVoutfonts was not changed, as this does not seem to be any different from the same folder in the TVout library, so it doesn't seem to clash.