mapbox / mapbox/cpp

Add narrative documentation on how we do binary deployment

Aperta
#48 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Nessun dato sulla lingua
Stelle
110
Fork
17
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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:

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da glossary.md e dalle pagine wiki esistenti di node-pre-gyp relative a External-libraries e FAQ. Segui il flusso documentato dal codice sorgente C++ attraverso i node addons fino alla distribuzione dei binari, includendo mason e node-pre-gyp, quindi integra in questo repository la documentazione precedente pertinente con collegamenti al glossario e al materiale correlato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp, nodejs
Ambito
build-system, documentation, release
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.