eclipse-thingweb / eclipse-thingweb/node-wot
Explaining how to use the CLI
- Vorherrschende Sprache
- TypeScript
- Sterne
- 192
- Forks
- 100
- Ø Merge
- 3 T. 4 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
At the moment, in order to understand how to use the `wot-servient` based CLI, one has to use the `-h` option and read on the terminal, which has limited place for explanations.
There should be explanation in the Readme (or another document like CLI.md) that explains what each option does in a verbose manner.
Beitragsleitfaden
Rechercherichtung
Beginne damit, die auf wot-servient basierende CLI mit der Option -h auszuführen, und prüfe das vorhandene README oder ermittle, ob ein Dokument CLI.md der bessere Ort ist. Dokumentiere ausführlich, was jede Option tut, und zeige die Vollständigkeit dadurch, dass ein Neuling die CLI verstehen kann, ohne sich ausschließlich auf die Terminalausgabe zu verlassen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100