Make usage instructions clearer

[DanielRichtmann]

Hi,

I've just stumbled over this package and it seems pretty interesting. However, I can't seem to get it to work. Maybe it's worth including the steps minimally required to produce a docstr for, e.g., python.
It's still not clear to me which function I need to call / keys I need to press to get the package to do what it's supposed to.

[jcs090218]

Sorry for the confusion.

You are right. It seems like the README.md is too comprehensive. I will try to improve the documentation, and make it clearer for users. 😖

[Jiriki86]

Hi,

I found your package and the gifs seem really nice. I am trying to use docstr for c++, but can not get it working as well. I think the readme is not tooo comprehensive, but simply lacks a simple example on how to set it up for a single language.

Why not provide the configuration for your c++ gifs?

[jcs090218]

Sorry, I was very busy with other things, hence I don't have much time to update this package. 😓 I will try to update it once I have some time.

But what I can do now is to post my config here, see jcs-emacs (if you don't mind looking at the code directly 😅) By searching docstr, you should see https://github.com/jcs-emacs/jcs-emacs/search?q=docstr

Specifically for c++, see lisp/mode/jcs-cc-mode.el file

[Jiriki86]

Hi,

thank you for the quick reply. I did not want to put pressure on you in any way. I understand that you most likely doing this in your free time.
Thanks for the work and providing your config.

[ratnesh1729]

thank you for the package.
Did anyone figure out how to use e.g. for python.