c++ - 我即将在 Sourceforge 上开源一个 C++ 项目。我可以获得有关代码组织的一些提示吗？

Question

我正准备根据 GPL 将我一直在从事的项目上传到 Sourceforge，并希望就如何以易于理解和使用的任何开发人员使用的方式组织代码获得一些建议可能会看看它，它与 git 以及 Sourceforge 呈现事物的方式配合得很好。

我的项目是一个跨平台的 C++ 应用程序，由以下部分组成:

• 执行实际工作的库部分
• 一个单独的 GUI 部分，它使用库部分
• 开源库，编译库需要包含路径
• 已修改的开源库，因此在某种意义上也是该项目的直接部分
• 所有库的编译输出

什么是最好的组织方式？

在我自己处理的时候，从项目根目录开始，我是这样的:
/库部分
/图形部分
/libs/开源库
/libs/修改后的开源库
/libs/compiled/保存编译后的库，包括在为 Windows 编译时一些不是来自开源库的库，例如 Cygwin 库文件

这是一种明智的组织方式吗？这符合惯例和期望吗？

checkin 我的项目时， checkin 开源库以及项目的一部分是否有意义？我认为这样做是有意义的，因为这样可以最大限度地减少为新开发人员设置和运行项目的摩擦。当然，我至少应该 checkin 修改后的开源库。

此外，在已编译库下的存储库中包含什么有意义？我认为最好告诉 git 忽略该目录并将其留空，因为它的内容在每个构建目标上都会不同，因为我的项目是跨平台的。

但是，对于那些不想自己构建和/或下载所有库以提供为主要平台预编译的库的人来说，这似乎也非常好。分享这些内容的最聪明的方法是什么？我正在查看 Sourceforge，如果不作为我的 git 存储库的一部分，我应该如何共享这些内容对我来说并不明显。

Answer 1

/
|- bin - Compiled binaries go here (not submitted to source-control)
|- build - buildscripts, tools used to build your code.
|- lib - Compiled libraries go here (not submitted to source-control)
|- local - (not submitted to source control)
   |- obj - Compiled object-files (not submitted to source-control)
   |- msvc - Autogenerated solution files for visual studio (not submitted to source control) (if applicable)
   |- scripts - Autogenerated script files (if applicable)
|- units
   |- libportion
      |- include - external headers for other units to see
      |- src
   |- guiportion
      |- include
      |- src
|- external
   |- externallib1
      |- include
      |- src

build - simplified build-script calling the correct convention to your buildscripts.
README - text-file explaining your software and the layout of your source.

这是我最近一直在使用的组织，其中的每个人都非常感谢它。它还可以轻松地将库彼此分开，并可以轻松地在库中提供内部 header 和外部 header 。

编辑:添加了“本地”目录。