added troubleshooting section to readme #273
Conversation
|
The most recent commit has the following changes:
Can you please review this third point (the section "histoqc.ui CLI" under "Basic Usage")? This documentation change resulted from issue #147, where HistoQC UI does not load images from the output directory unless data_directory is (a) the current working directory or (b) is explicitly set in the ui CLI. |
|
|
||
| Afterward completion of slide processing you can view the results in your web-browser simply by following the directions after typing: | ||
| ``` | ||
| python -m histoqc.ui |
There was a problem hiding this comment.
i'd probably just add a single line here:
cd histoqc_output_YYMMDD-hhmmss
python -m histoqc.ui
to further really reinforce that you're supposed to be in that sub-directory. i find people often don't read blocks of text but read code, so this'll hint it at them in case they missed it
this does assume however that histoqc was pip installed if they're in the sub directory, right? otherwise i don't think python -m works?
might want to add that as a comment, and then on the next line where you have the output directory specified say "OR set data_d...... (or if histoqc was not installed)"
or something like that?
There was a problem hiding this comment.
Sure. Since your last point applies to all modules of histoqc, I added a note in the installation section.
|
thanks jackson, merged in! |
This PR adds troubleshooting instructions to address issue #147