mapbox / mapbox/cpp

Add narrative documentation on how we do binary deployment

未关闭
#48 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
没有语言数据
星标
110
派生
17
PR 合并指标
30 天内没有已合并 PR

描述

Now that our https://github.com/mapbox/cpp/blob/master/glossary.md is fairly complete, it is a good time to add new, narrative docs that tie together glossary terms.

In particular, there is a need for a binary deployment doc that explains the flow from C++ source code -> node addons -> binary distribution.

Here is a first stab at listing things to cover in this doc:

We use mason for:

  • distributing pre-compiled (aka binary) static libraries for C/C++ code. And in rare cases shared libraries.
  • distributing source code of header-only libraries
  • distributing binaries of executables (aka command line programs).

We use node-pre-gyp for:

  • Binary deployment of node C++ addons
  • When those node C++ addons have external C/C++ dependencies we use mason to pull packages for them
  • Soon we'll open source https://github.com/mapbox/mason-js which will make these more seamless (no need for the mason bash scripts)

TODO:

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 glossary.md 以及现有的 node-pre-gyp wiki 页面 External-libraries 和 FAQ 开始。跟踪从 C++ 源代码经过 node addons 到二进制分发的文档化流程,涵盖 mason 和 node-pre-gyp,然后将相关的旧文档整合到此 repository 中,并添加指向术语表和相关材料的链接。

由索引模型根据 Issue 内容生成。

评估

技术栈
cpp, nodejs
领域
build-system, documentation, release
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。