-
Notifications
You must be signed in to change notification settings - Fork 47
Update install instructions, Readme, and add resources #3753
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
Conversation
llimeht
left a comment
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.
Huge improvement in the documentation, thanks!
A few comments inline.
I also wonder whether much of these docs should be somehow in the sphinx documentation... but now we have two sets of docs, one in md and one in rst.
INSTALL.md
Outdated
| ## Making a SasView Development Environment | ||
|
|
||
| If you're familiar with working with developing in Python, then the | ||
| very quick version is: |
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.
I'm not sure it's good to make the "short version if you know what you're doing" longer when there's already a longer version below. Maybe?
README.md
Outdated
|
|
||
| ## Getting started | ||
|
|
||
| ### Hello World |
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.
This is very long for README. It also doesn't test any of sasview, but rather sasmodels and bumps.
It's a nice "how to script stuff" intro - perhaps it's worth separating that out?
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.
@gonzalezma and @DrPaulSharp raised similar concerns (that this might not be the correct space).
Would you suggest this then be moved to the sasmodels/sasdata readme or just to a sepprate md file.
Alternatively I would suggest to change the into text/heading accordingly and making this section collapsable
Some Typos corrected. In 'Install using pip inside the working directory:' should be mentioned that the Linux environment is activated, and not the Windows enviroment. 'Hello World' example tested on Windows (10). Replace 'MyAwsomefit' by 'MyAwesomefit'
|
Some Typos corrected. |
added link to the marketplace
Corrected some Typos
This reverts commit 3b5726c4bef07b0392dcf7f03693d1b5a048a151.
This reverts commit 2095f01f734981d30694c6e4189ee47c3c98d299.
|
If your git knowledge is up to it, I'm quite comfortable with you rebasing and squashing commits so that this is a clean set of changes without accidental changes. |
|
I've pushed a few fixups and additional info to the the branch. I think it's better than what is currently there so worth merging - thank you @TLO218! We might want to consider moving the scripting example elsewhere, or at least putting some screenshots before it, but that can happen later, and getting the installation instructions updated is more urgent. |
Description
Update the Readme and make it feel more inviting
Fixes # (issue/issues)
Gives a quickstart guide to newcomers on how to install the packages, Links to most usefull resources and tries to gives example code to test the installation
How Has This Been Tested?
Provided example is used to test different install instrutions
additional maitanance
This adds a new
resources.mdfile along with an image for thesasview-hello_worldexample. By usingInstall.mdandResources.mdwith Pandoc to generate the corresponding web pages, we can simplify maintenance and minimize the risk of outdated information over time.currently it also mentions the issue with launching the gui throught sas as it's only been introduced after the 6.1.1 release.
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Review Checklist:
[if using the editor, use
[x]in place of[ ]to check a box]Install instructions (check at least one)
discussion