better-enums icon indicating copy to clipboard operation
better-enums copied to clipboard

Put enum.h inside include/betterenums subdirectory.

Open ecorm opened this issue 8 years ago • 3 comments

You should put enum.h inside an include/betterenums subdirectory of your Git repository. This would allow superproject build scripts to clone your Git repo as-is and add -I superproject/thirdpartylibs/betterenums/include compiler flags where appropriate.

To include your header, we would use

#include <betterenums/enum.h>

which would avoid collisions with other headers named enum.h.

ecorm avatar Mar 07 '17 21:03 ecorm

Agreed in principle, though, since it's a one-header library, it might be better to rename the file to better_enums.h, or something.

aantron avatar Mar 07 '17 22:03 aantron

If you decide to rename to better_enums.h, you should at least put it inside an include subdirectory, so that all the other files in your repository's root directory don't pollute the #include path. Many large project build scripts clone third-party dependencies directly from GitHub and leave the subrepo's file/directory structure intact.

ecorm avatar Mar 07 '17 23:03 ecorm

Fair enough.

aantron avatar Mar 07 '17 23:03 aantron