-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Provide better instructional materials #208
Conversation
Marking this PR as ready for review. @jinyz8888 @tonyshumlh @JohnShiuMK Please note that some links in README.md does not work yet as the ReadtheDocs page has not been rendered. I have tested locally and the links should work once this PR is merged into |
@SoloSynth1 i tried to run through every command in README and most things are fine, except the export of Evaluation Report that has error in lacking package |
What's your export target format? Is it HTML? |
Also if possible, would you mind to paste the whole error stack? |
I think adding |
in the README acknowledgement: Dr. Simon Goringfor |
Fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's fantastic, thanks!
This PR:
README.md
,CONTRIBUTING.md
Closes #205.