概要

  YSLib 项目是一个提供多个开源库组成的平台中立框架的项目,主要致力于以自然的方式开发跨平台本机应用。

  使用的许可证见源代码目录中的 LICENSE.TXT 。

  主要部分(非此项目维护的库除外)使用 C++ 编码,严格符合 ISO/IEC 14882 。(使用的 ISO 特性参见这里(en-US) 。和本项目相关的被报告的问题见这里(en-US) 。)

  项目当前为 Alpha 状态,具有以下接口兼容性策略:

  • 任意版本不保证依赖特定平台、工具链或构建配置的 ABI 兼容性。
  • 同一平台、工具链和构建配置的发布版本之间的 ABI 可能不兼容。
  • 库的 API 设计在局部调整而不保证在发布版本之间兼容。
  • 工具(列表参见目录)的 UI 可能会在构建中渐进修改;除非另行指定,添加的特性在之后的至少一个发布版本中保持向后兼容

  关于使用 YSLib 开发的基本步骤,参见入门

  目前已发布版本、进展和计划看这里

当前支持平台

待定支持平台

  • Android (arm-linux-androideabi)
  • MinGW64 (x86_64-w64-mingw32)
  • Linux32 (i686-linux-gnu)
  • Linux64 (x86_64-linux-gnu)

文档

YSLib 项目中的文档

  YSLib 项目中的文档主要包括以下几个部分:

  • 主要供项目维护者参考的开发文档,详见开发说明
    • 目录 /doc/vsd 下的文档可使用 Microsoft Office Visio 或 Microsoft Visual Studio 2013 查看。
  • 源代码文档,可使用 Doxygen 生成,参见构建文档
    • 当前源代码中的 Doxygen 命令主要编码为简体中文。未来计划使用 Doxygen 的 ~[LanguageId] 命令生成多种语言的文档。其它注释主要使用英文。
  • 其它非生成的文本文件,如 Readme.zh-CN.txt

关于本 wiki

  本 wiki 是和 YSLib 项目关联的项目。本 wiki 和 YSLib 项目组成了同一个项目组当前仅有的两个成员,每个项目都有单独的版本库。项目组的公共文档、 YSLib 的一般用户文档和重要特性列表主要由本 wiki 提供。 YSLib 项目中的文档主要面向项目的维护者。两者的文档构成双向引用,即 YSLib 项目可能引用本 wiki 的内容,反之亦然。

  除非另行指定,本 wiki 的内容适合当前最新的主分支版本(即版本库 master 分支标识为 tip 的版本)。

  编辑本 wiki 的规则参见这里(en-US)

  本页面有意引用所有本 wiki 的所有页面。

贡献

  对项目的贡献受到欢迎。由此提供的材料应在必要时由贡献者(及项目维护者)调整,以符合相应项目的许可证。

  **这个 wiki 规则被视为共识。**在项目文档内部的规则对维护者而不是其他贡献者有效。但是,项目中的内容应符合项目规则。

  要反馈或报告问题,使用 Bitbucket 问题跟踪系统,或按如下方式联系项目维护者。

项目内容规则

  下列指导原则一般地适用于所有项目。

  • **不重复发明轮子。**这里的项目只接受比别处更好的模块化组件。此处“更好”定义为“在至少一个方面比现有解决方案更有效地满足一致同意的已知需求”。
    • 参见特性注记的轮子列表和原理。
  • **拒绝不成熟的优化。**然而,何谓“不成熟”由需求决定,这很可能变化。

联系方式