Missing getting started documentation
Bug #1569139 reported by
Gerard Braad
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
steth |
Fix Released
|
Undecided
|
Han Chao |
Bug Description
The project currently has no complete instructions on how to setup the tool in a single- and/or multi-node environment. It would be ideal if a short summary of installation and usage can be given.
Please see: https:/
It is preferred to specify instructions using backticks and code blocks.
The README would need to refer to this document. Or the README should mention a basic usage; Install using `python setup.py`.
description: | updated |
Changed in steth: | |
status: | New → Confirmed |
assignee: | nobody → Han Chao (hanchao-v) |
Changed in steth: | |
status: | Confirmed → In Progress |
To post a comment you must log in.
We decide to use rst for documentation instead of md. Since there is limited documentation this is an easy change.