nodejs_demo doesn't work as described on web site; does via readme

Aperta
#851 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
node.js, python, rollup
Ambito
documentation

Direzione di ricerca

Compare the nodejs_demo instructions on installation_use.html with nodejs_demo/readme.txt, especially the transcrypt commands and the rollup step. First verify which command sequence works for running the demo with Node.js; done means the web documentation matches the working instructions and explains any required argument differences.

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

Descrizione

SUB: documentation

On the page https://www.transcrypt.org/docs/html/installation_use.html, there's a description of how to compile and run the nodejs_demo. However, following the instructions there lead to errors. There is a readme.txt in the nodejs_demo directory. It says to use rollup, which bundles the javascript into a CommonJS format which node can run. That necessary instruction is omitted from the web site version. Also the arguments to the transcrypt command are different; I'm not sure why.

I could offer a PR to fix the docs, but I'm not sure if there's some reason for the different arguments to transcrypt or for not using rollup in the description on the web site. The web site calls transcrypt with:
transcrypt -b -p .none nodejs_demo
whereas the readme.txt uses:
transcrypt -b nodejs_demo

Lingua principale
Python
Stelle
2.9k
Fork
218
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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.

Altre issue di TranscryptOrg/Transcrypt

Tutte le issue di TranscryptOrg/Transcrypt

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.