-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Description
This is an admittedly low-priority issue.
README.md is 197 lines.
The top half ("elevator-pitch") is faithfully presented in https://labgym.readthedocs.io/en/latest/
but the bottom half ("how to use") is not, it seems to be missing, I can't find it on readthedocs.
If this is unintentional (I'm not actually sure!) then the generation process should be fixed, or the "dead" content scrubbed?
Also noticing README.md has a lot of references (~20) to content living in Henry's fork (https://github.com/yujiahu415/LabGym).
The other documentation files do NOT cross-ref into Henry's fork, so maybe this one file, README.md, is under the radar in some sense and the cross-refs are unintentional.
lines chars
1 37 2272 CODE_OF_CONDUCT.md: ASCII text, with very long lines (538)
2 6 200 CONTRIBUTING.md: ASCII text
3 11 415 COPYRIGHT.txt: Unicode text, UTF-8 text, with CRLF line terminators
4 148 31919 LICENSE.txt: Non-ISO extended-ASCII text, with very long lines (2347), with CRLF line terminators
5 80 13575 LabGym_Zoo.md: ASCII text, with very long lines (624)
6 1897 213765 LabGym_extended_user_guide.pdf: PDF document, version 1.3, 8 pages
7 17396 4543841 LabGym_practical_guide.pdf: PDF document, version 1.6 (zip deflate encoded)
8 1 131 NOTICE.txt: ASCII text
9 197 13727 README.md: exported SGML document text, Unicode text, UTF-8 text, with very long lines (1234)
10 354 14451 docs/changelog.md: Unicode text, UTF-8 text, with very long lines (430)
11 142 4955 docs/contributing/developing.md: ASCII text
12 101 3875 docs/contributing/docs.md: ASCII text
13 13 250 docs/contributing/index.md: ASCII text
14 151 5903 docs/contributing/internal.md: ASCII text
15 140 4698 docs/contributing/setup.md: ASCII text
16 3 32 docs/features/analysis.md: ASCII text
17 8 62 docs/features/index.md: ASCII text
18 3 37 docs/features/preprocessing.md: ASCII text
19 3 32 docs/features/training.md: ASCII text
20 15 208 docs/index.md: exported SGML document text, ASCII text
21 18 876 docs/installation/index.md: ASCII text, with very long lines (332)
22 94 3373 docs/installation/linux.md: ASCII text, with very long lines (648)
23 47 1311 docs/installation/macos.md: ASCII text
24 60 2715 docs/installation/windows.md: ASCII text, with very long lines (649)
25 38 1098 docs/issues.md: ASCII text
26 3 39 docs/walkthroughs/background-subtraction.md: ASCII text
27 3 33 docs/walkthroughs/detector.md: ASCII text
28 26 661 docs/walkthroughs/index.md: ASCII text
29 3 33 docs/walkthroughs/static-image-analysis.md: ASCII text
30 6 146 docs/what-can-labgym-do.md: exported SGML document text, ASCII text
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels