search

larstvei / ox-gfm

Github Flavored Markdown Back-End for Org Export Engine
230 stars 44 forks source link

Add usage to README #18

Closed cbui closed 7 years ago

larstvei commented 7 years ago

Thanks for contributing!

I agree that the package should provide a usage section, but it needs to be more explanatory than a short nugget of elisp. If you provide that (i.e. some explanation of what to do with the snippet and what it is for), then I can merge the change.

Another comment, by including that usage section, it suggests (to me at least) that this is "the way" to use the package. This is not how I use it (I manually load it, due to infrequent use), and so the README should not suggest that such a snippet is necessary for using it. Perhaps the README should mention the (autoloaded) export functions? And maybe link to the org mode exporting documentation and suggest using the org-export-dispatch (C-c C-e).

cbui commented 7 years ago

Good feedback, updated.

larstvei commented 7 years ago

Thank you, this is great!

I will merge it as soon as I find the time (I want to read it properly and possible make some small changes before I merge).