Add narrative documentation on how we do binary deployment
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 110
- Forks
- 17
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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:
- integrate old node-pre-gyp docs into this repo and modify them to link to the glossary and this repo where appropriate. E.g. https://github.com/mapbox/node-pre-gyp/wiki/External-libraries, https://github.com/mapbox/node-pre-gyp/wiki/FAQ
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit glossary.md und den vorhandenen node-pre-gyp-Wiki-Seiten zu External-libraries und FAQ. Verfolge den dokumentierten Ablauf vom C++-Quellcode über node addons bis zur Binärdistribution, einschließlich mason und node-pre-gyp, und integriere anschließend die relevanten alten Dokumentationen mit Links zum Glossar und zu verwandtem Material in dieses Repository.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp, nodejs
- Bereich
- build-system, documentation, release
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100