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

Move header files into include/midifile folder. #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

no-more-secrets
Copy link

Effectively we add a folder "namespace" to the midifile headers.
This is standard practice when structuring a library (e.g. note
boost does this). When a parent project includes this library it
will be more clear which headers belong to the midifile
library.

Also a minor CMake fix is made which will associate the header
folder with the midifile CMake target in accordance with modern
CMake best practices.

These changes make the project more friendly to the common
workflow of incorporating the library into a larger project as a
git submodule.

Fixes #62

Effectively we add a folder "namespace" to the midifile headers.
This is standard practice when structuring a library (e.g. note
boost does this). When a parent project includes this library it
will be more clear which headers belong to the `midifile`
library.

Also a minor CMake fix is made which will associate the header
folder with the `midifile` CMake target in accordance with modern
CMake best practices.

These changes make the project more friendly to the common
workflow of incorporating the library into a larger project as a
git submodule.
@no-more-secrets
Copy link
Author

Ping!

@no-more-secrets
Copy link
Author

Is this repo still being maintained?

@craigsapp
Copy link
Owner

I pay attention to the repo every January/February when I teach MIDI in my class :-)

You still find this useful (as a Windows user, while I am a unix/mac user)? As long as no one on the watch list complains, I will do it this week.

When I use the files in an external project, I just copy them into the include/src directories of the project. But otherwise, it seems that the directory structure midifile/include/midifile is a bit redundant.

@no-more-secrets
Copy link
Author

When I use the files in an external project, I just copy them into the include/src directories of the project. But otherwise, it seems that the directory structure midifile/include/midifile is a bit redundant.

Note that when included from a C++ file it will be #include "midifile/..."; the "midifile/include" part is not visible since that is part of the header search paths. That's why it is not redundant from that point of view. This is a common practice in C++ library code bases.

Anyway, if you are planning to merge this, then please let me know so that I can update the branch and resolve the merge conflicts (which I don't want to do unless you're going to merge it). Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move headers so that project is submodule-friendly
2 participants