search

hyperspy / hyperspy-bundle

The HyperSpy-bundle Distribution
https://hyperspy.org/hyperspy-bundle
GNU General Public License v3.0
9 stars 10 forks source link

Add docs #67

Closed ericpre closed 2 years ago

ericpre commented 2 years ago

Add documentation to describe how to download, install and use the hyperspy-bundle. This is mostly adapted from previous workshop with some improvement and updates.

@francisco-dlp, @jlaehne, do you want to review this PR?

The documentation is available at https://hyperspy.org/hyperspy-bundle

hakonanes commented 2 years ago

The docs are very nice and tidy, I wish we had those to point participants to at a diffraction workshop at NTNU in June!

Two comments:

  1. The QtConsole image has tiny text which is only readable when opening the image separately
  2. How about adding "HyperSpy Bundle" beside the HyperSpy logo in the navigation bar (relevant config)?
hakonanes commented 2 years ago

Also, it should be "listed below" here: https://hyperspy-bundle.readthedocs.io/en/latest/index.html#difference-with-winpython.

ericpre commented 2 years ago

Thanks @hakonanes and @jlaehne for reviewing. The image of the terminal prompt still need to be updated, but I can't do it right now.

jlaehne commented 2 years ago

The image of the terminal prompt still need to be updated, but I can't do it right now.

Couldn't you just increase the :figwidth: to 70% or 80%?

Also the figure bundle_release_download.png will need to be updated due to typos ... but I guess there first needs to be a new release before a new screenshot can be made.