sagemath / sage-shell-mode

Emacs front end for SageMath
GNU General Public License v3.0
98 stars 16 forks source link

Making README more gentle to rookie Emacs users #16

Closed johanrosenkilde closed 7 years ago

johanrosenkilde commented 7 years ago

I went through the README and tried to make it more gentle and giving a better exemplification of what sage-shell-mode is good for. Some of it is similar to the landing page of sage-mode (which I wrote), but sage-shell-mode had much more complete technical documentation than sage-mode. I think the combination retains its informativeness while making it nicer for novice Emacs users.

stakemori commented 7 years ago

Thanks! This is very helpful. Your English is much better than mine. Here are a few remarks.

Anyway, thank you very much.

johanrosenkilde commented 7 years ago

Cool, thanks for merging. Sure - I'll use fix-branch next time.

I thought that require was necessary when you want to e.g. add a hook (as in the eldoc example). That's not the case?

stakemori commented 7 years ago

Sure - I'll use fix-branch next time.

Thanks.

I thought that require was necessary when you want to e.g. add a hook (as in the eldoc example). That's not the case?

add-hook defines a global variable if the hook is not defined. So add-hook works well with autoload.

johanrosenkilde commented 7 years ago

Ah, OK. Surely there'll be other cases where the require is necessary, but as long as none of the commands suggested in the help file need it, I guess it can just be removed :-)